diff --git a/src/engage/audiences/linked-audiences.md b/src/engage/audiences/linked-audiences.md index ded99e8ce7..726bae1d4e 100644 --- a/src/engage/audiences/linked-audiences.md +++ b/src/engage/audiences/linked-audiences.md @@ -13,7 +13,7 @@ With Linked Audiences, you can: - Preserve rich relationships between all the data in your warehouse by creating connections with any entity data back to your audience profile. - Build advanced audience segments that include the rich context needed for personalization downstream. -- Use a low code builder, enabling marketers to activate warehouse data without having to wait for data pull requests before launching campaigns to targeted audiences. +- Use a low code builder, enabling marketers to activate warehouse data without having to wait for data team requests before launching campaigns to targeted audiences. To learn more about specific use cases you can set up with Linked Audiences, see [Linked Audiences Use Cases](/docs/engage/audiences/linked-audiences-use-cases/). @@ -63,11 +63,11 @@ To build a Linked Audience: Optionally, select a folder to add this audience. 8. Click **Create Audience**. -After creating your Linked Audience, you will be brought to the Overview page with the Linked Audience in a disabled state. +After creating your Linked Audience, you'll be brought to the Overview page with the Linked Audience in a disabled state. ### Linked Audience conditions -The Linked Audiences builder sources profile trait and event keys from the data warehouse. This data must be synced to the data warehouse through [Profiles Sync](/docs/unify/profiles-sync/overview/) before you can reference it in the linked audience builder. If there is a profile trait that exists in the Segment Profile that hasn’t successfully synced to the data warehouse yet, it will be grayed out so that it can’t be selected. +The Linked Audiences builder sources profile trait and event keys from the data warehouse. This data must be synced to the data warehouse through [Profiles Sync](/docs/unify/profiles-sync/overview/) before you can reference it in the Linked Audience builder. If there is a profile trait that exists in the Segment Profile that hasn’t successfully synced to the data warehouse yet, it will be grayed out so that it can’t be selected. The Linked Audience builder also returns a subset of available entity property key values, event property and context key values, and profile trait key values that you can select in the input field drop-down. This eliminates the need to type in the exact value you want to filter on. If the value you’re looking for isn’t listed, you can manually enter it into the input field. Manually entered values are case-sensitive. @@ -85,10 +85,10 @@ When building your Linked Audience, you can add multiple conditions to a single |---------------------------|---------------------------------------| | with entity | Creates a condition that filters profiles associated with entity relationships defined in the [Data Graph](/docs/unify/linked-profiles/data-graph/). With this condition, you can navigate the full, nested entity relationships, and filter your audience on entity column values. Each subsequent entity you select in an entity branch acts as a filter over the profiles that are available at the next depth of that specific branch. | | without entity | Creates a condition that filters profiles that are not associated with entity relationships defined in the [Data Graph](/docs/unify/linked-profiles/data-graph/). With this condition, you can navigate the full, nested entity relationships, and filter your audience on entity column values. Each subsequent entity you select in an entity branch acts as a filter over the profiles that are available at the next depth of that specific branch.| -| with [ trait](/docs/unify/#enrich-profiles-with-traits) | Creates a condition that filters profiles with a specific trait. | -| without [ trait](/docs/unify/#enrich-profiles-with-traits)| Creates a condition that filters profiles without a specific trait.| +| with [trait](/docs/unify/#enrich-profiles-with-traits) | Creates a condition that filters profiles with a specific trait. | +| without [trait](/docs/unify/#enrich-profiles-with-traits)| Creates a condition that filters profiles without a specific trait.| | part of [audience](/docs/glossary/#audience) | Creates a condition that filters profiles that are part of an existing audience. | -| not part of [audience](/docs/glossary/#audience) | Creates a condition that filters profiles that are not part of an existing audience. | +| not part of [audience](/docs/glossary/#audience) | Creates a condition that filters profiles that aren't part of an existing audience. | | with [event](/docs/glossary/#event) | Creates a condition that filters profiles that have a specific event in their event history. You can also filter on event property values.| | without [event](/docs/glossary/#event) | Creates a condition that filters profiles that do not have a specific event in their event history. You can also filter on event property values.| @@ -97,7 +97,7 @@ at least: supports 1 or greater, exactly: supports 0 or greater, at most: supports 0 or greater. -*When filtering by 0, you can’t filter on by entity properties or on additional nested entities. +When filtering by 0, you can’t filter on by entity properties or on additional nested entities. #### Operator selection @@ -112,7 +112,7 @@ You can create audience definitions using either `AND` or `OR` operators across If you have defined entity conditions in your audience definition, you will see a “Matched Entities” tab in the audience preview to help you understand what entities qualified a user to be a part of an audience. -This information appears when you click the user profile generated from the audience preview. The contextual information encompasses entity relationships as well as entity column values that were used as filtering criteria in the audience definition. By default, Segment includes the entity ID. The data being returned is truncated - 10 entities at each level, 6 levels of depth. If you want to opt out of this functionality, contact Segment Support. +This information appears when you click the user profile generated from the audience preview. The contextual information encompasses entity relationships as well as entity column values that were used as filtering criteria in the audience definition. By default, Segment includes the entity ID. The data being returned is truncated - ten entities at each level, six levels of depth. If you want to opt out of this functionality, contact Segment Support. ![A screenshot of the Entity Explorer.](/docs/engage/images/entity_explorer.png) @@ -153,7 +153,7 @@ To activate your Linked Audience: > info "Linked Audiences destinations" > Linked Audiences only supports [Actions Destinations](/docs/connections/destinations/actions/#available-actions-based-destinations). List destinations aren't supported. -**Note:** Ensure your [destination has been enabled](/connections/destinations/catalog/) in Segment before you begin the steps below. +**Note:** Ensure you've [enabled your destination](/connections/destinations/catalog/) in Segment before you begin the steps below. 1. Navigate to **Engage > Audiences**. 2. Select the Linked Audience you set up in the previous step. @@ -214,7 +214,7 @@ Send a test event to ensure that everything is connected properly and your desti Enter the destination User id for the profile you want to use to test the event, then click **Send test event to destination**. -The Event content drop-down shows you a preview of what the data sent to your destination might look like. +The Event content dropdown shows you a preview of what the data sent to your destination might look like. ## Step 4: Enable your Linked Audience @@ -239,7 +239,7 @@ You can maintain your run schedule at any time from the audience's **Settings** You can also click **Run Now** on the Audience Overview page at any time (even if the run schedule is **Interval** Overview **Day and time**) to manually trigger a run on your warehouse and send data to enabled destinations. -There may be up to a 5 minute delay from the configured start time for audiences that are configured with the **Interval** and **Day and time** run schedules. For example, if you configured an audience with the **Day and time** compute schedule to run on Mondays at 8am, it can compute as late as Monday at 8:05am. This is to help us better manage our system load. +There may be up to a five minute delay from the configured start time for audiences that are configured with the **Interval** and **Day and time** run schedules. For example, if you configured an audience with the **Day and time** compute schedule to run on Mondays at 8am, it can compute as late as Monday at 8:05am. This is to help us better manage our system load. ## Step 5: Monitor your activation @@ -269,16 +269,15 @@ Linked Audiences have the following steps in Delivery Overview's pipeline view: You can create alerts related to the performance and throughput of Linked Audience syncs and receive in-app, email, and Slack notifications when event volume fluctuations occur. -> info "Generate a Slack webhook to receive Slack notifications" -> To receive an alert in a Slack channel, you must first create a Slack webhook. For more information about Slack webhooks, see Slack's [Sending messages using incoming webhooks](https://api.slack.com/messaging/webhooks){:target="_blank”} documentation. +> info "Slack and mailing list notification channels require additional setup" +> Before sending an alert to Slack, you must first create a Slack webhook. For more information about Slack webhooks, see Slack's [Sending messages using incoming webhooks](https://api.slack.com/messaging/webhooks){:target="_blank”} documentation. +> +> While you can only enter one email address per alert when signing up for email alerts, you can send the alert to multiple users by entering the email address of a mailing list. To create a mailing list, refer to the documentation for your email provider, like Google's [Create a group & choose group settings](https://support.google.com/groups/answer/2464926?hl=en){:target="_blank”} for Gmail or Microsoft's [Create and manage distribution groups](https://support.microsoft.com/en-us/office/distribution-groups-e8ba58a8-fab2-4aaf-8aa1-2a304052d2de#bkmk_create){:target="_blank”} for Outlook. To access Linked Audience alerting, navigate to **Engage > Audiences**, select a Linked Audience, and click the **Alerts** tab. On the **Alerts** tab, you can create new alerts and view all active alerts for this connection. You can only edit or delete the alerts that you create, unless you have the [Workspace Owner role](/docs/segment-app/iam/roles/). -> info "Deleting alerts created by other users requires Workspace Owner role" -> All users can delete alerts that they created, but only those with [Workspace Owner role](/docs/segment-app/iam/roles/) can delete alerts created by other users. - #### Activation event health spikes or drops You can create an Activation event health spikes or drops alert that notifies you when events sent from your audience to a downstream destination have failures to a destination above a certain threshold. For example, if you set a change percentage of 4% and your destination received 100 events from your audience over the first 24 hours, Segment would notify you the following day if your destination ingested fewer than 96 or more than 104 events. @@ -286,7 +285,7 @@ You can create an Activation event health spikes or drops alert that notifies yo To create an Activation event health spikes or drops alert: 1. From your Segment workspace's home page, navigate to **Engage > Audiences**. 2. Select the Audience you want to create an alert for, select the Alerts tab, and click **Create alert**. -3. On the Create alert sidesheet, select the **Activation event health spikes or drops** alert and pick a destination for which you'd like to monitor event health. +3. On the Create alert side sheet, select the **Activation event health spikes or drops** alert and pick a destination for which you'd like to monitor event health. 4. Enter a percentage threshold to trigger activation event health notifications. 5. Select one or more of the following alert channels: - **Email**: Select this to receive notifications at the provided email address. @@ -294,10 +293,6 @@ To create an Activation event health spikes or drops alert: - **In-app**: Select this to receive notifications in the Segment app. To view your notifications, select the bell next to your user icon in the Segment app. 6. Click **Save**. -To make changes to an Activation event health spikes or drops alert, select the icon in the Actions column for the alert and click **Edit**. - -To delete a Activation event health spikes or drops alert, select the icon in the Actions column for the alert and click **Delete**. - #### Audience size change You can create an Audience size change alert that notifies you when your audience increases or decreases by a certain threshold. For example, if you set a change percentage of 4% and your destination had 100 members over the first 24 hours, Segment would notify you the following day if your audience had fewer than 96 or more than 104 members. @@ -308,7 +303,7 @@ You can create an Audience size change alert that notifies you when your audienc To create an Audience size change alert: 1. From your Segment workspace's home page, navigate to **Engage > Audiences**. 2. Select the Linked Audience you want to create an alert for, select the Alerts tab, and click **Create alert**. -3. On the Create alert sidesheet, select the **Audience size change alert** and pick a destination for which you'd like to monitor event health. +3. On the Create alert side sheet, select the **Audience size change alert** and pick a destination for which you'd like to monitor event health. 4. Enter a percentage threshold to trigger audience size change notifications. 5. Select one or more of the following alert channels: - **Email**: Select this to receive notifications at the provided email address. @@ -316,10 +311,6 @@ To create an Audience size change alert: - **In-app**: Select this to receive notifications in the Segment app. To view your notifications, select the bell next to your user icon in the Segment app. 6. Click **Save**. -To make changes to an Audience size change alert, select the icon in the Actions column for the alert and click **Edit**. - -To delete a Audience size change alert, select the icon in the Actions column for the alert and click **Delete**. - ## Maintaining Linked Audiences You can maintain your Linked Audience by accessing these tabs on the main page of your Linked Audience: diff --git a/src/unify/data-graph/linked-events.md b/src/unify/data-graph/linked-events.md index 34e20f13d3..df98332284 100644 --- a/src/unify/data-graph/linked-events.md +++ b/src/unify/data-graph/linked-events.md @@ -4,29 +4,26 @@ plan: unify hidden: false --- -Use Linked Events to enrich real-time event streams with entities from your data warehouse to your destinations. Insert additional event context for downstream applications for richer data about each event. +Use Linked Events to enrich real-time event streams with entities from your data warehouse to your destinations. Insert additional event context for downstream applications for richer data about each event. -> info "Consent enforcement for Linked Events" -> You can use [Consent Management](/docs/privacy/consent-management/) to enforce consent in your downstream destinations for Linked Events stamped with the [consent object](/docs/privacy/consent-management/consent-in-segment-connections/#consent-object). You must enable Consent Management and have consent stamped on events from event streaming sources to use Consent Management. You cannot use Linked Events to enrich events with consent preferences that are stored in your warehouse. - -On this page, you'll learn how to get started with Linked Events. +On this page, you'll learn how to get started with Linked Events. Linked Events supports Snowflake, BigQuery, Redshift, and Databricks. -> info "Linked Events warehouse support" -> Linked Events supports Snowflake, BigQuery, Redshift, and Databricks. +> info "Consent enforcement for Linked Events" +> You can use [Consent Management](/docs/privacy/consent-management/) to enforce consent in your downstream destinations for Linked Events stamped with the [consent object](/docs/privacy/consent-management/consent-in-segment-connections/#consent-object). You must enable Consent Management and have consent stamped on events from event streaming sources to use Consent Management. You cannot use Linked Events to enrich events with consent preferences that are stored in your warehouse. ## Use cases With Linked Events, you can: - **Add details to events for precise targeting**. Enable targeting by appending product events that only have `product_id` with full product SKU details from your warehouse. -- **Sync enriched data**. Add a loyalty ID to event payloads before sending it downstream to destinations such as Amplitude, Mixpanel, and more. +- **Sync enriched data**. Add a loyalty ID to event payloads before sending it downstream to destinations like Amplitude, Mixpanel, and more. - **Reduce load times**. Enrich page view events with products and subscriptions connected to that view, and send that to Google Analytics 4 to lighten the front end and reduce page loading time. ## Prerequisites To use Linked Events, you'll need the following: -1. A supported data warehouse. +1. A supported data warehouse. Linked Events supports Snowflake, BigQuery, Redshift, and Databricks. 2. Access to Unify in your workspace. 3. Access to the actions-based destination you'll be using with Linked Events so that you can validate your data. @@ -37,9 +34,8 @@ To use Linked Events, you'll need the following: The following Segment access [roles](/docs/segment-app/iam/roles/) apply to Linked Events: -**Entities Admin Access**: Entities Admins have the ability to view and edit entity models and connection details. - -**Entities Read-only Access**: Entities Read-only users have the ability to view entity models. +- **Entities Admin Access**: Entities Admins have the ability to view and edit entity models and connection details. +- **Entities Read-only Access**: Entities Read-only users have the ability to view entity models. To create models and enrich events in destinations, you need to be a `Workspace Owner` or have the following roles: @@ -50,24 +46,24 @@ To create models and enrich events in destinations, you need to be a `Workspace ## Step 1: Set up your data warehouse and permissions > info "" -> Linked Events uses Segment's [Reverse ETL](/docs/connections/reverse-etl/) infrastructure for pulling in data from your warehouse. +> Linked Events uses Segment's [Reverse ETL](/docs/connections/reverse-etl/) infrastructure to pull in data from your warehouse. -To get started, you'll need to set up your data warehouse and provide the correct access detailed in the set up steps below. Linked Events supports [BigQuery](/docs/unify/linked-profiles/setup-guides/bigquery-setup/), [Databricks](/docs/unify/linked-profiles/setup-guides/databricks-setup/), [Snowflake](/docs/unify/linked-profiles/setup-guides/snowflake-setup/), and [Redshift](/docs/unify/linked-profiles/setup-guides/redshift-setup/). +To get started, you'll need to set up your data warehouse and provide Segment the access detailed in the setup steps below. Linked Events supports [BigQuery](/docs/unify/linked-profiles/setup-guides/bigquery-setup/), [Databricks](/docs/unify/linked-profiles/setup-guides/databricks-setup/), [Snowflake](/docs/unify/linked-profiles/setup-guides/snowflake-setup/), and [Redshift](/docs/unify/linked-profiles/setup-guides/redshift-setup/). ## Step 2: Connect your warehouse to the Data Graph > success "" -> Before getting started with the Data Graph, be sure to set up your warehouse permissions. +> Before getting started with the Data Graph, set up your warehouse permissions. 1. Navigate to **Unify > Data graph** and click **Add warehouse**. -2. Select a warehouse to connect from the [supported data warehouses](#supported-data-warehouses). +2. Select one of the [supported data warehouses](#supported-data-warehouses). 3. Connect your warehouse. 3. Click **Test Connection** to be sure your warehouse is connected. 4. After a successful test, click **Save**. ### Schema -Linked Events uses Reverse ETL to compute the incremental changes to your data directly within your data warehouse. The Unique Identifier column detects data changes, such as new, updated, and deleted records. +Linked Events uses [Reverse ETL](/docs/connections/reverse-etl/) to compute the incremental changes to your data directly within your data warehouse. The Unique Identifier column detects data changes, like new, updated, and deleted records. For Segment to compute data changes in your warehouse, Segment requires both read and write permissions to the warehouse schema table. At a high level, the extract process requires read permissions for the query being executed. Segment tracks changes to the query results through tables that Segment manages in a dedicated schema (for example, `_segment_reverse_etl`), which requires some write permissions. @@ -80,17 +76,17 @@ The table below shows the data warehouses Linked Events supports. View the Segme | Data Warehouse | Steps | |------------------------|-------------------------| -| [Snowflake](/docs/unify/linked-profiles/setup-guides/snowflake-setup/) | 1. Configure your snowflake database.
2. Enter your credentials.
3. Test the Connection.
4. Click **Save**. | +| [Snowflake](/docs/unify/linked-profiles/setup-guides/snowflake-setup/) | 1. Configure your snowflake database.
2. Enter your credentials.
3. Test the connection.
4. Click **Save**. | | [BigQuery](/docs/unify/linked-profiles/setup-guides/bigquery-setup/) | 1. Add your credentials to the database that has tables with the entities you want to enrich your event with.
2. Test your connection. | | [Redshift](/docs/unify/linked-profiles/setup-guides/redshift-setup/) | 1. Select the Redshift cluster you want to connect.
2. [Configure](/docs/connections/storage/catalog/redshift/#networking) the correct network and security settings. | -| [Databricks](/docs/unify/linked-profiles/setup-guides/databricks-setup/) | 1. Configure your Databricks catalog.
2. Enter your credentials.
3. Test the Connection.
4. Click **Save**. | +| [Databricks](/docs/unify/linked-profiles/setup-guides/databricks-setup/) | 1. Configure your Databricks catalog.
2. Enter your credentials.
3. Test the connection.
4. Click **Save**. | ## Step 3: Build your Data Graph -The Data Graph is a semantic layer that represents a subset of relevant business data that you'll use to enrich events in downstream tools. Use the configuration language spec below to add models to build out your Data Graph. +The Data Graph is a semantic layer that represents a subset of relevant business data that you'll use to enrich events in downstream tools. Use the configuration language spec below to add models and build out your Data Graph. -Each Unify space has one Data Graph. The current version is v0.0.6 but this may change in the future as Segment accepts feedback about the process. +Each Unify space has one Data Graph. The current version is v0.0.6, but this may change in the future as Segment accepts feedback about the process. > warning "" > Deleting entities and relationships are not yet supported. @@ -160,8 +156,7 @@ To configure your sync schedule: ### Add entities -After you load a sample event, you can add entities from the **Enrich events with entities** section. You’ll select an entity, then an entity match property. -- The entity match property is the property in the event that you want to match to the primary key. +After you load a sample event, you can add entities from the **Enrich events with entities** section. You’ll select an entity, then an entity match property, or the property in the event that you want to match to the primary key. After you’ve added an entity and match property, add your event enrichments. @@ -178,7 +173,7 @@ In the Mappings tab, locate the **Select Mappings** section where you can enrich 4. Click **Save**. #### Testing with Linked Events Enrichments -The [Event Tester and Mappings Tester](/docs/connections/test-connections/#) support testing enrichments from Linked Events, allowing you to verify that entity data is correctly attached to your events before they reach destinations. When you have Linked Events configured, these enrichments appear in your test payload, showing you exactly how profile traits will add to your events. +The [Event Tester and Mappings Tester](/docs/connections/test-connections/) support testing enrichments from Linked Events, allowing you to verify that entity data is correctly attached to your events before they reach destinations. When you have Linked Events configured, these enrichments appear in your test payload, showing you exactly how profile traits will add to your events. When you test mappings with Linked Events Enrichments: * You can view the enriched fields in the **Request** section of the test results.