Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
40 changes: 39 additions & 1 deletion docs/data-product-studio/data-products/ui/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ After selecting "Create from scratch" a form will appear on the page. Enter your

:::note
_The name of your data product must be unique to ensure proper identification and avoid conflicts._
:::note
:::

![Event specifications](images/event-specifications.png)

Expand Down Expand Up @@ -104,3 +104,41 @@ If the new version of the Data Structure introduces incompatibilities with the e
![Conflict resolution Event Specification](images/conflict_resolution.png)

This mechanism ensures that teams can benefit from updated Data Structures while maintaining the integrity and accuracy of their Event Specifications. Users are empowered to make informed decisions during the upgrade process, with clear visual cues and options to handle conflicts effectively.

## Event Specification Code Generation

To accelerate your implementation of event tracking, Snowplow Console includes pre-generated code snippets specifically for custom self-describing events. These snippets can be accessed directly within the Console interface to significantly reduce the time and effort required for integrating event tracking functionality into your applications.

### Working with Event Specifications

When viewing an event specification, the "Working with this event" section provides two key tabs:

- **Implementation**: access ready-to-use tracking code for your event
- **Querying**: view example SQL queries to retrieve your event data from the warehouse

:::note
For standard Snowplow events (page views, screen views, page pings, and self-describing events), tracking code is available out of the box without requiring any additional configuration.
:::

### Implementation - Code Snippets

The Implementation tab generates tracking code snippets tailored to your event specification. You can:

- **Select your tracker type**: choose between JavaScript tracker options (tag-based or npm-based)
- **Copy code directly**: use the generated code snippets immediately in your application

:::note
Draft data structures can't be used for event validation during testing or production.
:::

![Implementation code snippets](images/code-snippets.png)

### Querying - SQL Examples

The Querying tab provides example SQL queries to help you retrieve and analyze your event data. You can:

- **Select your warehouse**: choose from Snowflake, BigQuery, Redshift, Databricks, and other supported warehouses
- **View tailored queries**: see SQL examples optimized for your selected warehouse
- **Access event data**: query both the event properties and attached entities

![Querying SQL Examples](images/sql-example.png)