From eafb62cf49331604602164005e47ed91f7f41ced Mon Sep 17 00:00:00 2001 From: peterikladious Date: Fri, 11 Aug 2023 15:58:33 +1000 Subject: [PATCH 01/22] Create index.md --- .../cloud-apps/unlocking-attribution/index.md | 151 ++++++++++++++++++ 1 file changed, 151 insertions(+) create mode 100644 src/connections/sources/catalog/cloud-apps/unlocking-attribution/index.md diff --git a/src/connections/sources/catalog/cloud-apps/unlocking-attribution/index.md b/src/connections/sources/catalog/cloud-apps/unlocking-attribution/index.md new file mode 100644 index 0000000000..b1b09cf401 --- /dev/null +++ b/src/connections/sources/catalog/cloud-apps/unlocking-attribution/index.md @@ -0,0 +1,151 @@ +# 💥 Segment Partner Source Documentation Template + +> Hi Partners 👋🏼 +> +> Welcome to Segment - glad to have you onboard! This doc serves as a guideline for your team to create best-in-class documentation alongside your amazing product. +> +> Here are the guidelines we want you to have in mind when writing out your documentation: +> +> - Be succinct and simple in your writing. Reduce text bloat where possible. +> - Avoid 1st person language as it’s confusing for customers if they don’t know who wrote the docs (Segment or the Partner). +> - Where pre-reading is required, hyperlink to other more generic parts of Segment’s (or your) documentation. +> +> - Screenshots/Images are generally discouraged unless absolutely necessary +> +> The below template intends to provide a standardized structure. To submit your documentation, complete the following steps: +> +> 1. Fork and clone the `segment-docs` repo locally +> 2. Create a new branch (e.g., partner-name/source) +> 3. Create an `index.md` file in the following path `src/connections/sources/catalog/cloud-apps/{source-slug}/index.md +> 4. Copy the template below into your `index.md` file, and edit it to be in line with how your integration operates +> 5. Add, commit, and push your code, then submit a pull request to the `segment-docs` repo +> +> If a section does not apply to your integration, feel free to remove. Please don’t create separate sections unless absolutely necessary. In most cases, creating a H3 (###) sub-heading under an existing section is the best option! +> +> If you have any questions in the meantime, please reach out to our team at partner-support@segment.com. + +## Template begins here... +--- +title: [integration_name] Source +--- + +> (delete after reading) Include a 1-2 sentence introduction to your company and the value it provides to customers - updating the name and hyperlink. Please leave the utm string unchanged. + +[](https://yourintegration.com/?utm_source=segmentio&utm_medium=docs&utm_campaign=partners) provides self-serve predictive analytics for growth marketers, leveraging machine learning to automate audience insights and recommendations. + +This is an [Event Cloud Source](https://segment.com/docs/sources/#event-cloud-sources) which can not only export data into your Segment warehouse, but they can also federate the exported data into your other enabled Segment Destinations. + +> (delete after reading) Update your company name and support email address. + +This source is maintained by . For any issues with the source, [contact their Support team](mailto:support@.com). + +> (delete after reading) Update your company name (x2) and support email address. + +_**NOTE:** The Source is currently in beta, which means that they are still actively developing the source. This doc was last updated on . If you are interested in joining their beta program or have any feedback to help improve the Source and its documentation, [let their team know](mailto:support@.com)!_ + +## Getting Started + +> (delete after reading) Include clear, succinct steps including hyperlinks to where customers can locate the place in your app to enter their Segment writekey. + +1. From your workspace's [Sources catalog page](https://app.segment.com/goto-my-workspace/sources/catalog) click **Add Source**. +2. Search for "" in the Sources Catalog, select , and click **Add Source**. +3. On the next screen, give the Source a nickname configure any other settings. + + - The nickname is used as a label in the Segment app, and Segment creates a related schema name in your warehouse. The nickname can be anything, but we recommend using something that reflects the source itself and distinguishes amongst your environments (eg. SourceName_Prod, SourceName_Staging, SourceName_Dev). + +4. Click **Add Source** to save your settings. +5. Copy the Write key from the Segment UI and log in to your account - navigate to Settings > Integrations > Segment Integration and paste the key to connect. + +## Stream + +> (delete after reading) Clarify the type of Segment events your integration will send. + + uses our stream Source component to send Segment event data. It uses a server-side (select from `track`, `identify`, `page`, `group`) method(s) to send data to Segment. These events are then available in any destination that accepts server-side events, and available in a schema in your data warehouse, so you can query using SQL. + +> (delete after reading) Clarify how your integration includes user identifiers in your event payloads, the example below is from Klaviyo: + +The default behavior is for Klaviyo to pass the userId associated with the email recipient as the userId. There are cases in which Klaviyo does not have an associated userId, in which case the email address will be passed in as the anonymousId. + +> (delete after reading) For each of the below sections, populate the event and properties that a customer would expect to receive in their downstream tools from your Event Source. + +## Events + +The table below lists events that sends to Segment. These events appear as tables in your warehouse, and as regular events in other Destinations. includes the `userId` if available. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Event NameDescription
Email SentEmail was sent successfully
Email OpenedProspect opened the email
Link ClickedProspect clicked the tracking link
Email RepliedProspect replied to the email sent
Email BouncedEmail servers rejected the email
Email UnsubscribedProspect clicked the unsubscribe link
+ +## Event Properties + +The table below list the properties included in the events listed above. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Property NameDescription
`event`Email event type
`userId`Prospect email ID
`email_id`ID of the email
`fromId`Sender email ID
`email_subject`Subject line of the email
`link`URL of the link clicked
+ +## Adding Destinations + +Now that your Source is set up, you can connect it with Destinations. + +Log into your downstream tools and check to see that your events appear as expected, and that they contain all of the properties you expect. If your events and properties don’t appear, check the [Event Delivery](https://segment.com/docs/connections/event-delivery/) tool, and refer to the Destination docs for each tool for troubleshooting. + +If there are any issues with how the events are arriving to Segment, [contact the support team](mailto:support@.com). + +--- + +> Congratulations! 🎉 You’ve finished the documentation for your Segment integration. If there’s any additional information or nuance which did not fit in the above template and that you want to share with our mutual customers, feel free to include these as a separate section for us to review. If not, you may now submit this doc to our team. From 122f316fe72c8f073f427bf3f75645a13a95395b Mon Sep 17 00:00:00 2001 From: peterikladious Date: Mon, 14 Aug 2023 10:33:41 +1000 Subject: [PATCH 02/22] Updated --- .../cloud-apps/unlocking-attribution/index.md | 243 ++++++++---------- 1 file changed, 113 insertions(+), 130 deletions(-) diff --git a/src/connections/sources/catalog/cloud-apps/unlocking-attribution/index.md b/src/connections/sources/catalog/cloud-apps/unlocking-attribution/index.md index b1b09cf401..76cf48b3dd 100644 --- a/src/connections/sources/catalog/cloud-apps/unlocking-attribution/index.md +++ b/src/connections/sources/catalog/cloud-apps/unlocking-attribution/index.md @@ -1,151 +1,134 @@ -# 💥 Segment Partner Source Documentation Template - -> Hi Partners 👋🏼 -> -> Welcome to Segment - glad to have you onboard! This doc serves as a guideline for your team to create best-in-class documentation alongside your amazing product. -> -> Here are the guidelines we want you to have in mind when writing out your documentation: -> -> - Be succinct and simple in your writing. Reduce text bloat where possible. -> - Avoid 1st person language as it’s confusing for customers if they don’t know who wrote the docs (Segment or the Partner). -> - Where pre-reading is required, hyperlink to other more generic parts of Segment’s (or your) documentation. -> -> - Screenshots/Images are generally discouraged unless absolutely necessary -> -> The below template intends to provide a standardized structure. To submit your documentation, complete the following steps: -> -> 1. Fork and clone the `segment-docs` repo locally -> 2. Create a new branch (e.g., partner-name/source) -> 3. Create an `index.md` file in the following path `src/connections/sources/catalog/cloud-apps/{source-slug}/index.md -> 4. Copy the template below into your `index.md` file, and edit it to be in line with how your integration operates -> 5. Add, commit, and push your code, then submit a pull request to the `segment-docs` repo -> -> If a section does not apply to your integration, feel free to remove. Please don’t create separate sections unless absolutely necessary. In most cases, creating a H3 (###) sub-heading under an existing section is the best option! -> -> If you have any questions in the meantime, please reach out to our team at partner-support@segment.com. - -## Template begins here... --- -title: [integration_name] Source +title: Unlocking Attribution Source --- > (delete after reading) Include a 1-2 sentence introduction to your company and the value it provides to customers - updating the name and hyperlink. Please leave the utm string unchanged. -[](https://yourintegration.com/?utm_source=segmentio&utm_medium=docs&utm_campaign=partners) provides self-serve predictive analytics for growth marketers, leveraging machine learning to automate audience insights and recommendations. +The [Unlocking Attribution](https://yourintegration.com/?utm_source=segmentio&utm_medium=docs&utm_campaign=partners) source is a powerful solution designed to model attribution data, aiding marketers in identifying the most effective inbound channels for driving conversions. This documentation will guide you through the process of setting up and utilizing the "Unlocking Attribution" source within your Twilio Segment environment. Unlocking Attribution is built on top of your pre-existing Segment implementation, ensuring you can be up and running in under an hour. -This is an [Event Cloud Source](https://segment.com/docs/sources/#event-cloud-sources) which can not only export data into your Segment warehouse, but they can also federate the exported data into your other enabled Segment Destinations. +This is an [Object Cloud Source](https://segment.com/docs/connections/sources/#object-cloud-sources) which can data into your Segment warehouse. This means it can be used both within the Unlocking Attribution tool itself, or from reporting/analytics tools which read from your data warehouse. -> (delete after reading) Update your company name and support email address. +This source is maintained by Unlocking Attribution. For any issues with the source, [contact their Support team](mailto:support@unlockinggrowth.co). -This source is maintained by . For any issues with the source, [contact their Support team](mailto:support@.com). - -> (delete after reading) Update your company name (x2) and support email address. - -_**NOTE:** The Source is currently in beta, which means that they are still actively developing the source. This doc was last updated on . If you are interested in joining their beta program or have any feedback to help improve the Source and its documentation, [let their team know](mailto:support@.com)!_ +_**NOTE:** The Unlocking Attribution Source is currently in beta, which means that they are still actively developing the source. This doc was last updated on August 14th, 2023. If you are interested in joining their beta program or have any feedback to help improve the Unlocking Attribution Source and its documentation, [let their team know](mailto:support@unlockinggrowth.co)!_ ## Getting Started > (delete after reading) Include clear, succinct steps including hyperlinks to where customers can locate the place in your app to enter their Segment writekey. 1. From your workspace's [Sources catalog page](https://app.segment.com/goto-my-workspace/sources/catalog) click **Add Source**. -2. Search for "" in the Sources Catalog, select , and click **Add Source**. +2. Search for "Unlocking Attribution" in the Sources Catalog, select Unlocking Attribution, and click **Add Source**. 3. On the next screen, give the Source a nickname configure any other settings. - The nickname is used as a label in the Segment app, and Segment creates a related schema name in your warehouse. The nickname can be anything, but we recommend using something that reflects the source itself and distinguishes amongst your environments (eg. SourceName_Prod, SourceName_Staging, SourceName_Dev). 4. Click **Add Source** to save your settings. -5. Copy the Write key from the Segment UI and log in to your account - navigate to Settings > Integrations > Segment Integration and paste the key to connect. - -## Stream - -> (delete after reading) Clarify the type of Segment events your integration will send. - - uses our stream Source component to send Segment event data. It uses a server-side (select from `track`, `identify`, `page`, `group`) method(s) to send data to Segment. These events are then available in any destination that accepts server-side events, and available in a schema in your data warehouse, so you can query using SQL. - -> (delete after reading) Clarify how your integration includes user identifiers in your event payloads, the example below is from Klaviyo: - -The default behavior is for Klaviyo to pass the userId associated with the email recipient as the userId. There are cases in which Klaviyo does not have an associated userId, in which case the email address will be passed in as the anonymousId. - -> (delete after reading) For each of the below sections, populate the event and properties that a customer would expect to receive in their downstream tools from your Event Source. - -## Events - -The table below lists events that sends to Segment. These events appear as tables in your warehouse, and as regular events in other Destinations. includes the `userId` if available. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Event NameDescription
Email SentEmail was sent successfully
Email OpenedProspect opened the email
Link ClickedProspect clicked the tracking link
Email RepliedProspect replied to the email sent
Email BouncedEmail servers rejected the email
Email UnsubscribedProspect clicked the unsubscribe link
- -## Event Properties - -The table below list the properties included in the events listed above. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Property NameDescription
`event`Email event type
`userId`Prospect email ID
`email_id`ID of the email
`fromId`Sender email ID
`email_subject`Subject line of the email
`link`URL of the link clicked
- -## Adding Destinations - -Now that your Source is set up, you can connect it with Destinations. - -Log into your downstream tools and check to see that your events appear as expected, and that they contain all of the properties you expect. If your events and properties don’t appear, check the [Event Delivery](https://segment.com/docs/connections/event-delivery/) tool, and refer to the Destination docs for each tool for troubleshooting. - -If there are any issues with how the events are arriving to Segment, [contact the support team](mailto:support@.com). +5. Select "Workplace Settings" from within the "Settings" section of the left hand side menu. +6. Select the "Access Management" section from this page. +7. Select the "Tokens" section from this page. +8. Click the "+ Create Token" button on this page +9. Enter a description such as "Unlocking Attribution", select "Workspace Owner" and click "Create" +10. Copy the token that is presented on the screen. +11. Now, switch to your account in Unlocking Attribution and within the Onboarding Wizard, paste the taken you copied in step 10. +12. Click "Connect" and then follow the remaining steps within the onboarding wizard. ---- -> Congratulations! 🎉 You’ve finished the documentation for your Segment integration. If there’s any additional information or nuance which did not fit in the above template and that you want to share with our mutual customers, feel free to include these as a separate section for us to review. If not, you may now submit this doc to our team. +### Sync + +The Unlocking Attribution source is built with a sync component, which means that Unlocking Attribution writes to Segment on a regular basis, when modelling is re-performed on your customer data (typically on a daily basis). In the initial sync, all historical modelling is performed and written according to the Collections Table below. The objects are written into a separate schema, corresponding to the source instance's schema name you designated upon creation (for example, `ug_attribution.media_spend_items`). + +Segment's sync component uses an upsert API, so the data in your warehouse loaded using sync reflects the latest state of the corresponding resource in Unlocking Attribution. For example, if `conversions.value` goes from `0` to `212` between syncs, on its next sync that conversion's value will be `212`. + +The source syncs and warehouse syncs are independent processes. Source runs pull your data into the Segment Hub, and warehouse runs flush that data to your warehouse. Sources will sync with Segment daily. Depending on your Warehouses plan, Segment pushes the Source data to your warehouse on the interval associated with your billing plan. + + +## Collections +Collections are the groupings of resources that Segment pulls from your source. In your warehouse, each collection gets its own table. + +| Collection | Type | Description | +| --------------------------------- | ------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `conversions` | object | This table contains each identified conversion event, as configured in Unlocking Attribution and detected by the modelling. | +| `convresion_touch_lookup` | object | This table contains a cross-reference between each conversion and all the pre-conversion touches which the end-user had. | +| `touches` | object | A touch is defined as any interaction that a user/customer/prospect had leading up to the conversion event. This generally means website visits, but can sometimes have broader definitions, based on the exact implementation. +| `media_spend_items` | object | All cost data from the various media platforms is downloaded and stored in the the Media Spend Items and Media Spend Daily Spend tables. +| `media_spend_daily_spend` | object | This table captures the daily spend for each campaign (and sometimes broken down by Ad Collective or Ad Id). + +## Collection Properties +Below are tables outlining the properties included in the collections listed above. + +### conversions + +| Property Name | Description | +| ----------------------------- | ----------------------------------------------------------------------------------------------------- | +| `id` | The unique ID of this conversion event | +| `anonymous_id` | If available, the anonymous_id of the user who performed the conversion event | +| `user_id` | If available, the user_id of the user who performed the conversion event | +| `conversiontype` | The name of the conversion event | +| `timestamp` | The date/time that the conversion event occurred | +| `value` | The value (typically revenue) of the conversion event | + +### conversion_touch_lookup + +| Property Name | Description | +| ----------------------------- | ----------------------------------------------------------------------------------------------------- | +| `conversion` | The unique ID of the conversion event | +| `touch_id` | The unique ID of the specific touch | + +### touches + +| Property Name | Description | +| ----------------------------- | ----------------------------------------------------------------------------------------------------- | +| `timestamp` | The date/time that the touch occurred | +| `id` | The unique ID of this touch | +| `context_page_url` | The full URL of the page viewed | +| `context_page_path` | The path of the page viewed | +| `context_page_title` | The title of the page viewed | +| `context_page_referrer` | The referrer from where the user clicked from to get to this page | +| `context_campaign_source` | The contents of the utm_source query parameter in the URL | +| `context_campaign_medium` | The contents of the utm_medium query parameter in the URL | +| `context_campaign_name` | The contents of the utm_campaign query parameter in the URL | +| `context_campaign_content` | The contents of the utm_content query parameter in the URL | +| `context_campaign_terms` | The contents of the utm_terms query parameter in the URL | +| `campaign` | The unique ID of the “Media Spend Item” object which this touch was mapped to | +| `search_narrative` | The plain-English description of how this particular touch was mapped to campaign cost data | + + +### media_spend_items +All cost data from the various media platforms is downloaded and stored in the the Media Spend Items and Media Spend Daily Spend tables. Regardless of the media platform, the data is formatted to have the following key unique identifiers/attributes: + +* **Campaign Name** - The name of the campaign as defined the media platform. In some platforms, this could be derived from the “Category” field or “Campaign Group” field +* **Ad Collective Name** - The name of the Ad Collective (also known as Ad Set, or Ad Group across various platforms) +* **Campaign Id** - The unique ID of the campaign, as determined by the media platform +* **Ad Collective Id** - The unique ID of the Ad Collective, as determined by the media platform +Each row in the Media Spend Items table represent a unique combination of the above 4 attributes. After matching a touch against a campaign, the `campaign` identifier in the `touches` collection points to a row from this table. + + +| Property Name | Description | +| ----------------------------- | ----------------------------------------------------------------------------------------------------- | +| `campaign_name` | The name of the campaign | +| `campaign_id` | The unique ID of the campaign, as set by the paid media platform | +| `id` | The unique ID of this item | +| `ad_collective_name` | The name of the Ad Collective | +| `ad_collective_id` | The unique ID of the Ad Collective, as set by the paid media platform | +| `media_source` | The platform of this media item | +| `type` | The type of this media item (Paid, Organic) | + + +### media_spend_daily_spend +All cost data from the various media platforms is downloaded and stored in the the Media Spend Items and Media Spend Daily Spend tables. Regardless of the media platform, the data is formatted to have the following key unique identifiers/attributes: + +* **Campaign Name** - The name of the campaign as defined the media platform. In some platforms, this could be derived from the “Category” field or “Campaign Group” field +* **Ad Collective Name** - The name of the Ad Collective (also known as Ad Set, or Ad Group across various platforms) +* **Campaign Id** - The unique ID of the campaign, as determined by the media platform +* **Ad Collective Id** - The unique ID of the Ad Collective, as determined by the media platform +Each row in the Media Spend Items table represent a unique combination of the above 4 attributes. After matching a touch against a campaign, the `campaign` identifier in the `touches` collection points to a row from this table. + + +| Property Name | Description | +| ----------------------------- | ----------------------------------------------------------------------------------------------------- | +| `campaign` | The unique ID of the media_spend_items item, which this spend row corresponds to | +| `date_start` | The date of this spending item | +| `spend` | The amount of spend on that day | + + +--- From dd048a555d4ae481a3c911ac916bbb341979ba25 Mon Sep 17 00:00:00 2001 From: peterikladious Date: Mon, 14 Aug 2023 10:35:51 +1000 Subject: [PATCH 03/22] Updates --- .../catalog/cloud-apps/unlocking-attribution/index.md | 9 --------- 1 file changed, 9 deletions(-) diff --git a/src/connections/sources/catalog/cloud-apps/unlocking-attribution/index.md b/src/connections/sources/catalog/cloud-apps/unlocking-attribution/index.md index 76cf48b3dd..5c73b784fe 100644 --- a/src/connections/sources/catalog/cloud-apps/unlocking-attribution/index.md +++ b/src/connections/sources/catalog/cloud-apps/unlocking-attribution/index.md @@ -2,8 +2,6 @@ title: Unlocking Attribution Source --- -> (delete after reading) Include a 1-2 sentence introduction to your company and the value it provides to customers - updating the name and hyperlink. Please leave the utm string unchanged. - The [Unlocking Attribution](https://yourintegration.com/?utm_source=segmentio&utm_medium=docs&utm_campaign=partners) source is a powerful solution designed to model attribution data, aiding marketers in identifying the most effective inbound channels for driving conversions. This documentation will guide you through the process of setting up and utilizing the "Unlocking Attribution" source within your Twilio Segment environment. Unlocking Attribution is built on top of your pre-existing Segment implementation, ensuring you can be up and running in under an hour. This is an [Object Cloud Source](https://segment.com/docs/connections/sources/#object-cloud-sources) which can data into your Segment warehouse. This means it can be used both within the Unlocking Attribution tool itself, or from reporting/analytics tools which read from your data warehouse. @@ -115,13 +113,6 @@ Each row in the Media Spend Items table represent a unique combination of the ab ### media_spend_daily_spend -All cost data from the various media platforms is downloaded and stored in the the Media Spend Items and Media Spend Daily Spend tables. Regardless of the media platform, the data is formatted to have the following key unique identifiers/attributes: - -* **Campaign Name** - The name of the campaign as defined the media platform. In some platforms, this could be derived from the “Category” field or “Campaign Group” field -* **Ad Collective Name** - The name of the Ad Collective (also known as Ad Set, or Ad Group across various platforms) -* **Campaign Id** - The unique ID of the campaign, as determined by the media platform -* **Ad Collective Id** - The unique ID of the Ad Collective, as determined by the media platform -Each row in the Media Spend Items table represent a unique combination of the above 4 attributes. After matching a touch against a campaign, the `campaign` identifier in the `touches` collection points to a row from this table. | Property Name | Description | From 167e750cea82261294cd13d108796d08059becc9 Mon Sep 17 00:00:00 2001 From: peterikladious Date: Mon, 14 Aug 2023 10:37:53 +1000 Subject: [PATCH 04/22] Changed table references to collections --- .../cloud-apps/unlocking-attribution/index.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/src/connections/sources/catalog/cloud-apps/unlocking-attribution/index.md b/src/connections/sources/catalog/cloud-apps/unlocking-attribution/index.md index 5c73b784fe..6b19a16569 100644 --- a/src/connections/sources/catalog/cloud-apps/unlocking-attribution/index.md +++ b/src/connections/sources/catalog/cloud-apps/unlocking-attribution/index.md @@ -33,7 +33,7 @@ _**NOTE:** The Unlocking Attribution Source is currently in beta, which means th ### Sync -The Unlocking Attribution source is built with a sync component, which means that Unlocking Attribution writes to Segment on a regular basis, when modelling is re-performed on your customer data (typically on a daily basis). In the initial sync, all historical modelling is performed and written according to the Collections Table below. The objects are written into a separate schema, corresponding to the source instance's schema name you designated upon creation (for example, `ug_attribution.media_spend_items`). +The Unlocking Attribution source is built with a sync component, which means that Unlocking Attribution writes to Segment on a regular basis, when modelling is re-performed on your customer data (typically on a daily basis). In the initial sync, all historical modelling is performed and written according to the Collections structure below. The objects are written into a separate schema, corresponding to the source instance's schema name you designated upon creation (for example, `ug_attribution.media_spend_items`). Segment's sync component uses an upsert API, so the data in your warehouse loaded using sync reflects the latest state of the corresponding resource in Unlocking Attribution. For example, if `conversions.value` goes from `0` to `212` between syncs, on its next sync that conversion's value will be `212`. @@ -45,11 +45,11 @@ Collections are the groupings of resources that Segment pulls from your source. | Collection | Type | Description | | --------------------------------- | ------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `conversions` | object | This table contains each identified conversion event, as configured in Unlocking Attribution and detected by the modelling. | -| `convresion_touch_lookup` | object | This table contains a cross-reference between each conversion and all the pre-conversion touches which the end-user had. | +| `conversions` | object | This collection contains each identified conversion event, as configured in Unlocking Attribution and detected by the modelling. | +| `convresion_touch_lookup` | object | This collection contains a cross-reference between each conversion and all the pre-conversion touches which the end-user had. | | `touches` | object | A touch is defined as any interaction that a user/customer/prospect had leading up to the conversion event. This generally means website visits, but can sometimes have broader definitions, based on the exact implementation. -| `media_spend_items` | object | All cost data from the various media platforms is downloaded and stored in the the Media Spend Items and Media Spend Daily Spend tables. -| `media_spend_daily_spend` | object | This table captures the daily spend for each campaign (and sometimes broken down by Ad Collective or Ad Id). +| `media_spend_items` | object | All cost data from the various media platforms is downloaded and stored in the the Media Spend Items and Media Spend Daily Spend collections. +| `media_spend_daily_spend` | object | This collection captures the daily spend for each campaign (and sometimes broken down by Ad Collective or Ad Id). ## Collection Properties Below are tables outlining the properties included in the collections listed above. @@ -92,13 +92,13 @@ Below are tables outlining the properties included in the collections listed abo ### media_spend_items -All cost data from the various media platforms is downloaded and stored in the the Media Spend Items and Media Spend Daily Spend tables. Regardless of the media platform, the data is formatted to have the following key unique identifiers/attributes: +All cost data from the various media platforms is downloaded and stored in the the Media Spend Items and Media Spend Daily Spend collections. Regardless of the media platform, the data is formatted to have the following key unique identifiers/attributes: * **Campaign Name** - The name of the campaign as defined the media platform. In some platforms, this could be derived from the “Category” field or “Campaign Group” field * **Ad Collective Name** - The name of the Ad Collective (also known as Ad Set, or Ad Group across various platforms) * **Campaign Id** - The unique ID of the campaign, as determined by the media platform * **Ad Collective Id** - The unique ID of the Ad Collective, as determined by the media platform -Each row in the Media Spend Items table represent a unique combination of the above 4 attributes. After matching a touch against a campaign, the `campaign` identifier in the `touches` collection points to a row from this table. +Each row in the Media Spend Items collection represent a unique combination of the above 4 attributes. After matching a touch against a campaign, the `campaign` identifier in the `touches` collection points to a row from this collection. | Property Name | Description | From 2efd5f43ec036b4cf0a3c2cc731505d26581cf40 Mon Sep 17 00:00:00 2001 From: ugpeter <89007350+ugpeter@users.noreply.github.com> Date: Tue, 29 Aug 2023 14:02:42 +1000 Subject: [PATCH 05/22] Update src/connections/sources/catalog/cloud-apps/unlocking-attribution/index.md Co-authored-by: stayseesong <83784848+stayseesong@users.noreply.github.com> --- .../sources/catalog/cloud-apps/unlocking-attribution/index.md | 1 - 1 file changed, 1 deletion(-) diff --git a/src/connections/sources/catalog/cloud-apps/unlocking-attribution/index.md b/src/connections/sources/catalog/cloud-apps/unlocking-attribution/index.md index 6b19a16569..863b39dcac 100644 --- a/src/connections/sources/catalog/cloud-apps/unlocking-attribution/index.md +++ b/src/connections/sources/catalog/cloud-apps/unlocking-attribution/index.md @@ -12,7 +12,6 @@ _**NOTE:** The Unlocking Attribution Source is currently in beta, which means th ## Getting Started -> (delete after reading) Include clear, succinct steps including hyperlinks to where customers can locate the place in your app to enter their Segment writekey. 1. From your workspace's [Sources catalog page](https://app.segment.com/goto-my-workspace/sources/catalog) click **Add Source**. 2. Search for "Unlocking Attribution" in the Sources Catalog, select Unlocking Attribution, and click **Add Source**. From b99a9a2c87f5e2736ab99d58998af004cf4d78cc Mon Sep 17 00:00:00 2001 From: ugpeter <89007350+ugpeter@users.noreply.github.com> Date: Tue, 29 Aug 2023 14:03:45 +1000 Subject: [PATCH 06/22] Update src/connections/sources/catalog/cloud-apps/unlocking-attribution/index.md Co-authored-by: stayseesong <83784848+stayseesong@users.noreply.github.com> --- .../sources/catalog/cloud-apps/unlocking-attribution/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/connections/sources/catalog/cloud-apps/unlocking-attribution/index.md b/src/connections/sources/catalog/cloud-apps/unlocking-attribution/index.md index 863b39dcac..e823f3d007 100644 --- a/src/connections/sources/catalog/cloud-apps/unlocking-attribution/index.md +++ b/src/connections/sources/catalog/cloud-apps/unlocking-attribution/index.md @@ -4,7 +4,7 @@ title: Unlocking Attribution Source The [Unlocking Attribution](https://yourintegration.com/?utm_source=segmentio&utm_medium=docs&utm_campaign=partners) source is a powerful solution designed to model attribution data, aiding marketers in identifying the most effective inbound channels for driving conversions. This documentation will guide you through the process of setting up and utilizing the "Unlocking Attribution" source within your Twilio Segment environment. Unlocking Attribution is built on top of your pre-existing Segment implementation, ensuring you can be up and running in under an hour. -This is an [Object Cloud Source](https://segment.com/docs/connections/sources/#object-cloud-sources) which can data into your Segment warehouse. This means it can be used both within the Unlocking Attribution tool itself, or from reporting/analytics tools which read from your data warehouse. +This is an [Object Cloud Source](/docs/connections/sources/#object-cloud-sources) which can import data into your Segment warehouse. This means it can be used both within the Unlocking Attribution tool itself, or from the analytics tools which read from your data warehouse. This source is maintained by Unlocking Attribution. For any issues with the source, [contact their Support team](mailto:support@unlockinggrowth.co). From 1251fca76e6b9d247167736c78cb1a9bd50c5caa Mon Sep 17 00:00:00 2001 From: ugpeter <89007350+ugpeter@users.noreply.github.com> Date: Tue, 29 Aug 2023 14:04:50 +1000 Subject: [PATCH 07/22] Update src/connections/sources/catalog/cloud-apps/unlocking-attribution/index.md Co-authored-by: stayseesong <83784848+stayseesong@users.noreply.github.com> --- .../sources/catalog/cloud-apps/unlocking-attribution/index.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/src/connections/sources/catalog/cloud-apps/unlocking-attribution/index.md b/src/connections/sources/catalog/cloud-apps/unlocking-attribution/index.md index e823f3d007..faa14898da 100644 --- a/src/connections/sources/catalog/cloud-apps/unlocking-attribution/index.md +++ b/src/connections/sources/catalog/cloud-apps/unlocking-attribution/index.md @@ -14,7 +14,8 @@ _**NOTE:** The Unlocking Attribution Source is currently in beta, which means th 1. From your workspace's [Sources catalog page](https://app.segment.com/goto-my-workspace/sources/catalog) click **Add Source**. -2. Search for "Unlocking Attribution" in the Sources Catalog, select Unlocking Attribution, and click **Add Source**. +2. Search for *Unlocking Attribution* in the Sources Catalog. +3. Select **Unlocking Attribution** and click **Add Source**. 3. On the next screen, give the Source a nickname configure any other settings. - The nickname is used as a label in the Segment app, and Segment creates a related schema name in your warehouse. The nickname can be anything, but we recommend using something that reflects the source itself and distinguishes amongst your environments (eg. SourceName_Prod, SourceName_Staging, SourceName_Dev). From 700f26c728ddcdda6d4e0d6d35b6a4d6a743813c Mon Sep 17 00:00:00 2001 From: ugpeter <89007350+ugpeter@users.noreply.github.com> Date: Tue, 29 Aug 2023 14:05:01 +1000 Subject: [PATCH 08/22] Update src/connections/sources/catalog/cloud-apps/unlocking-attribution/index.md Co-authored-by: stayseesong <83784848+stayseesong@users.noreply.github.com> --- .../sources/catalog/cloud-apps/unlocking-attribution/index.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/src/connections/sources/catalog/cloud-apps/unlocking-attribution/index.md b/src/connections/sources/catalog/cloud-apps/unlocking-attribution/index.md index faa14898da..0fbf4c503f 100644 --- a/src/connections/sources/catalog/cloud-apps/unlocking-attribution/index.md +++ b/src/connections/sources/catalog/cloud-apps/unlocking-attribution/index.md @@ -8,7 +8,8 @@ This is an [Object Cloud Source](/docs/connections/sources/#object-cloud-sources This source is maintained by Unlocking Attribution. For any issues with the source, [contact their Support team](mailto:support@unlockinggrowth.co). -_**NOTE:** The Unlocking Attribution Source is currently in beta, which means that they are still actively developing the source. This doc was last updated on August 14th, 2023. If you are interested in joining their beta program or have any feedback to help improve the Unlocking Attribution Source and its documentation, [let their team know](mailto:support@unlockinggrowth.co)!_ +> info "" +> The Unlocking Attribution Source is currently in beta. If you're interested in joining the beta program or have any feedback to help improve the Unlocking Attribution Source and its documentation, [let the team know](mailto:support@unlockinggrowth.co). ## Getting Started From a8e2124ee8117099506fa9e44a863d77d56eda25 Mon Sep 17 00:00:00 2001 From: ugpeter <89007350+ugpeter@users.noreply.github.com> Date: Tue, 29 Aug 2023 14:05:13 +1000 Subject: [PATCH 09/22] Update src/connections/sources/catalog/cloud-apps/unlocking-attribution/index.md Co-authored-by: stayseesong <83784848+stayseesong@users.noreply.github.com> --- .../cloud-apps/unlocking-attribution/index.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/src/connections/sources/catalog/cloud-apps/unlocking-attribution/index.md b/src/connections/sources/catalog/cloud-apps/unlocking-attribution/index.md index 0fbf4c503f..3d1137d9b2 100644 --- a/src/connections/sources/catalog/cloud-apps/unlocking-attribution/index.md +++ b/src/connections/sources/catalog/cloud-apps/unlocking-attribution/index.md @@ -57,14 +57,14 @@ Below are tables outlining the properties included in the collections listed abo ### conversions -| Property Name | Description | -| ----------------------------- | ----------------------------------------------------------------------------------------------------- | -| `id` | The unique ID of this conversion event | -| `anonymous_id` | If available, the anonymous_id of the user who performed the conversion event | -| `user_id` | If available, the user_id of the user who performed the conversion event | -| `conversiontype` | The name of the conversion event | -| `timestamp` | The date/time that the conversion event occurred | -| `value` | The value (typically revenue) of the conversion event | +Property Name | Description +---------------- | ------------ +`id` | The unique ID of the conversion event. +`anonymous_id` | The anonymous_id of the user who performed the conversion event. +`user_id` | The user_id of the user who performed the conversion event. +`conversiontype` | The name of the conversion event. +`timestamp` | The date and time that the conversion event occurred. +`value` | The value of the conversion event. This is typically revenue. ### conversion_touch_lookup From 629f929fdba6e384b2935777cf96a87c67350a58 Mon Sep 17 00:00:00 2001 From: ugpeter <89007350+ugpeter@users.noreply.github.com> Date: Tue, 29 Aug 2023 14:05:28 +1000 Subject: [PATCH 10/22] Update src/connections/sources/catalog/cloud-apps/unlocking-attribution/index.md Co-authored-by: stayseesong <83784848+stayseesong@users.noreply.github.com> --- .../cloud-apps/unlocking-attribution/index.md | 24 +++++++++---------- 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/src/connections/sources/catalog/cloud-apps/unlocking-attribution/index.md b/src/connections/sources/catalog/cloud-apps/unlocking-attribution/index.md index 3d1137d9b2..4793d914ae 100644 --- a/src/connections/sources/catalog/cloud-apps/unlocking-attribution/index.md +++ b/src/connections/sources/catalog/cloud-apps/unlocking-attribution/index.md @@ -17,19 +17,19 @@ This source is maintained by Unlocking Attribution. For any issues with the sour 1. From your workspace's [Sources catalog page](https://app.segment.com/goto-my-workspace/sources/catalog) click **Add Source**. 2. Search for *Unlocking Attribution* in the Sources Catalog. 3. Select **Unlocking Attribution** and click **Add Source**. -3. On the next screen, give the Source a nickname configure any other settings. - - - The nickname is used as a label in the Segment app, and Segment creates a related schema name in your warehouse. The nickname can be anything, but we recommend using something that reflects the source itself and distinguishes amongst your environments (eg. SourceName_Prod, SourceName_Staging, SourceName_Dev). - -4. Click **Add Source** to save your settings. -5. Select "Workplace Settings" from within the "Settings" section of the left hand side menu. -6. Select the "Access Management" section from this page. -7. Select the "Tokens" section from this page. -8. Click the "+ Create Token" button on this page -9. Enter a description such as "Unlocking Attribution", select "Workspace Owner" and click "Create" +4. Give the Source a nickname. + - The nickname is used as a label in the Segment app, and Segment creates a related schema name in your warehouse. The nickname can be anything, but we recommend using something that reflects the source itself and distinguishes amongst your environments (eg. SourceName_Prod, SourceName_Staging, SourceName_Dev). + +5. Enter the configuration setting. +6. Click **Add Source** to save your settings. +7. Navigate to **Settings > Workspace Settings** +8. Select the **Access Management** tab. +7. Select the **Tokens** tab. +8. Click the **+ Create Token**. +9. Enter a description such as *Unlocking Attribution*, select **Workspace Owner** and click **Create**. 10. Copy the token that is presented on the screen. -11. Now, switch to your account in Unlocking Attribution and within the Onboarding Wizard, paste the taken you copied in step 10. -12. Click "Connect" and then follow the remaining steps within the onboarding wizard. +11. Switch to your account in Unlocking Attribution and within the Onboarding Wizard, paste the token you copied. +12. Click **Connect** and follow the remaining steps within the onboarding wizard. ### Sync From 43dfe4d4bd8da021e2c7edf98ca32ebd47c4040c Mon Sep 17 00:00:00 2001 From: ugpeter <89007350+ugpeter@users.noreply.github.com> Date: Tue, 29 Aug 2023 14:05:43 +1000 Subject: [PATCH 11/22] Update src/connections/sources/catalog/cloud-apps/unlocking-attribution/index.md Co-authored-by: stayseesong <83784848+stayseesong@users.noreply.github.com> --- .../sources/catalog/cloud-apps/unlocking-attribution/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/connections/sources/catalog/cloud-apps/unlocking-attribution/index.md b/src/connections/sources/catalog/cloud-apps/unlocking-attribution/index.md index 4793d914ae..84acc4c998 100644 --- a/src/connections/sources/catalog/cloud-apps/unlocking-attribution/index.md +++ b/src/connections/sources/catalog/cloud-apps/unlocking-attribution/index.md @@ -38,7 +38,7 @@ The Unlocking Attribution source is built with a sync component, which means tha Segment's sync component uses an upsert API, so the data in your warehouse loaded using sync reflects the latest state of the corresponding resource in Unlocking Attribution. For example, if `conversions.value` goes from `0` to `212` between syncs, on its next sync that conversion's value will be `212`. -The source syncs and warehouse syncs are independent processes. Source runs pull your data into the Segment Hub, and warehouse runs flush that data to your warehouse. Sources will sync with Segment daily. Depending on your Warehouses plan, Segment pushes the Source data to your warehouse on the interval associated with your billing plan. +The source syncs and warehouse syncs are independent processes. Source runs pull your data into the Segment Hub, and warehouse runs flush that data to your warehouse. Sources sync with Segment daily. Depending on your Warehouses plan, Segment pushes the Source data to your warehouse on the interval associated with your billing plan. ## Collections From d3e63a1f244049cc5d47321b05bde875a5b0087b Mon Sep 17 00:00:00 2001 From: ugpeter <89007350+ugpeter@users.noreply.github.com> Date: Tue, 29 Aug 2023 14:05:55 +1000 Subject: [PATCH 12/22] Update src/connections/sources/catalog/cloud-apps/unlocking-attribution/index.md Co-authored-by: stayseesong <83784848+stayseesong@users.noreply.github.com> --- .../sources/catalog/cloud-apps/unlocking-attribution/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/connections/sources/catalog/cloud-apps/unlocking-attribution/index.md b/src/connections/sources/catalog/cloud-apps/unlocking-attribution/index.md index 84acc4c998..e38dcd7c68 100644 --- a/src/connections/sources/catalog/cloud-apps/unlocking-attribution/index.md +++ b/src/connections/sources/catalog/cloud-apps/unlocking-attribution/index.md @@ -36,7 +36,7 @@ This source is maintained by Unlocking Attribution. For any issues with the sour The Unlocking Attribution source is built with a sync component, which means that Unlocking Attribution writes to Segment on a regular basis, when modelling is re-performed on your customer data (typically on a daily basis). In the initial sync, all historical modelling is performed and written according to the Collections structure below. The objects are written into a separate schema, corresponding to the source instance's schema name you designated upon creation (for example, `ug_attribution.media_spend_items`). -Segment's sync component uses an upsert API, so the data in your warehouse loaded using sync reflects the latest state of the corresponding resource in Unlocking Attribution. For example, if `conversions.value` goes from `0` to `212` between syncs, on its next sync that conversion's value will be `212`. +Segment's sync component uses an upsert API, so the data in your warehouse loaded using sync reflects the latest state of the corresponding resource in Unlocking Attribution. For example, if `conversions.value` goes from `0` to `212` between syncs, on its next sync, that conversion's value will be `212`. The source syncs and warehouse syncs are independent processes. Source runs pull your data into the Segment Hub, and warehouse runs flush that data to your warehouse. Sources sync with Segment daily. Depending on your Warehouses plan, Segment pushes the Source data to your warehouse on the interval associated with your billing plan. From 98778c008ee6d7365e3db2cce0a68988c78559bf Mon Sep 17 00:00:00 2001 From: ugpeter <89007350+ugpeter@users.noreply.github.com> Date: Tue, 29 Aug 2023 14:07:09 +1000 Subject: [PATCH 13/22] Update src/connections/sources/catalog/cloud-apps/unlocking-attribution/index.md Co-authored-by: stayseesong <83784848+stayseesong@users.noreply.github.com> --- .../sources/catalog/cloud-apps/unlocking-attribution/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/connections/sources/catalog/cloud-apps/unlocking-attribution/index.md b/src/connections/sources/catalog/cloud-apps/unlocking-attribution/index.md index e38dcd7c68..8917fc6c33 100644 --- a/src/connections/sources/catalog/cloud-apps/unlocking-attribution/index.md +++ b/src/connections/sources/catalog/cloud-apps/unlocking-attribution/index.md @@ -34,7 +34,7 @@ This source is maintained by Unlocking Attribution. For any issues with the sour ### Sync -The Unlocking Attribution source is built with a sync component, which means that Unlocking Attribution writes to Segment on a regular basis, when modelling is re-performed on your customer data (typically on a daily basis). In the initial sync, all historical modelling is performed and written according to the Collections structure below. The objects are written into a separate schema, corresponding to the source instance's schema name you designated upon creation (for example, `ug_attribution.media_spend_items`). +The Unlocking Attribution source is built with a sync component, which means that Unlocking Attribution writes to Segment on a regular basis when modeling is re-performed on your customer data (typically on a daily basis). In the initial sync, all historical modeling is performed and written according to the Collections structure below. The objects are written into a separate schema, corresponding to the source instance's schema name you designated upon creation (for example, `ug_attribution.media_spend_items`). Segment's sync component uses an upsert API, so the data in your warehouse loaded using sync reflects the latest state of the corresponding resource in Unlocking Attribution. For example, if `conversions.value` goes from `0` to `212` between syncs, on its next sync, that conversion's value will be `212`. From 4abf9652e8dae4a05791aca59e386502a71e71f6 Mon Sep 17 00:00:00 2001 From: ugpeter <89007350+ugpeter@users.noreply.github.com> Date: Tue, 29 Aug 2023 14:10:10 +1000 Subject: [PATCH 14/22] Update index.md (based on feedback) --- .../sources/catalog/cloud-apps/unlocking-attribution/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/connections/sources/catalog/cloud-apps/unlocking-attribution/index.md b/src/connections/sources/catalog/cloud-apps/unlocking-attribution/index.md index 8917fc6c33..f3018b658b 100644 --- a/src/connections/sources/catalog/cloud-apps/unlocking-attribution/index.md +++ b/src/connections/sources/catalog/cloud-apps/unlocking-attribution/index.md @@ -2,7 +2,7 @@ title: Unlocking Attribution Source --- -The [Unlocking Attribution](https://yourintegration.com/?utm_source=segmentio&utm_medium=docs&utm_campaign=partners) source is a powerful solution designed to model attribution data, aiding marketers in identifying the most effective inbound channels for driving conversions. This documentation will guide you through the process of setting up and utilizing the "Unlocking Attribution" source within your Twilio Segment environment. Unlocking Attribution is built on top of your pre-existing Segment implementation, ensuring you can be up and running in under an hour. +The [Unlocking Attribution](https://unlockinggrowth.co/products/?utm_source=segmentio&utm_medium=docs&utm_campaign=partners) source is a powerful solution designed to model attribution data, aiding marketers in identifying the most effective inbound channels for driving conversions. This documentation will guide you through the process of setting up and utilizing the "Unlocking Attribution" source within your Twilio Segment environment. Unlocking Attribution is built on top of your pre-existing Segment implementation, ensuring you can be up and running in under an hour. This is an [Object Cloud Source](/docs/connections/sources/#object-cloud-sources) which can import data into your Segment warehouse. This means it can be used both within the Unlocking Attribution tool itself, or from the analytics tools which read from your data warehouse. From 19c71bbda3144075453acd71b02cbda99bf26296 Mon Sep 17 00:00:00 2001 From: ugpeter <89007350+ugpeter@users.noreply.github.com> Date: Tue, 29 Aug 2023 14:10:22 +1000 Subject: [PATCH 15/22] Update src/connections/sources/catalog/cloud-apps/unlocking-attribution/index.md Co-authored-by: stayseesong <83784848+stayseesong@users.noreply.github.com> --- .../sources/catalog/cloud-apps/unlocking-attribution/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/connections/sources/catalog/cloud-apps/unlocking-attribution/index.md b/src/connections/sources/catalog/cloud-apps/unlocking-attribution/index.md index f3018b658b..23b37c1cb7 100644 --- a/src/connections/sources/catalog/cloud-apps/unlocking-attribution/index.md +++ b/src/connections/sources/catalog/cloud-apps/unlocking-attribution/index.md @@ -14,7 +14,7 @@ This source is maintained by Unlocking Attribution. For any issues with the sour ## Getting Started -1. From your workspace's [Sources catalog page](https://app.segment.com/goto-my-workspace/sources/catalog) click **Add Source**. +1. Navigate to **Connections > Catalog** and select the **Sources** tab of the catalog. 2. Search for *Unlocking Attribution* in the Sources Catalog. 3. Select **Unlocking Attribution** and click **Add Source**. 4. Give the Source a nickname. From 2c652ba5205b99425a0d106811f417c54bf0b6a3 Mon Sep 17 00:00:00 2001 From: ugpeter <89007350+ugpeter@users.noreply.github.com> Date: Tue, 29 Aug 2023 14:10:38 +1000 Subject: [PATCH 16/22] Update src/connections/sources/catalog/cloud-apps/unlocking-attribution/index.md Co-authored-by: stayseesong <83784848+stayseesong@users.noreply.github.com> --- .../cloud-apps/unlocking-attribution/index.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/src/connections/sources/catalog/cloud-apps/unlocking-attribution/index.md b/src/connections/sources/catalog/cloud-apps/unlocking-attribution/index.md index 23b37c1cb7..287395d7c9 100644 --- a/src/connections/sources/catalog/cloud-apps/unlocking-attribution/index.md +++ b/src/connections/sources/catalog/cloud-apps/unlocking-attribution/index.md @@ -44,13 +44,13 @@ The source syncs and warehouse syncs are independent processes. Source runs pull ## Collections Collections are the groupings of resources that Segment pulls from your source. In your warehouse, each collection gets its own table. -| Collection | Type | Description | -| --------------------------------- | ------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `conversions` | object | This collection contains each identified conversion event, as configured in Unlocking Attribution and detected by the modelling. | -| `convresion_touch_lookup` | object | This collection contains a cross-reference between each conversion and all the pre-conversion touches which the end-user had. | -| `touches` | object | A touch is defined as any interaction that a user/customer/prospect had leading up to the conversion event. This generally means website visits, but can sometimes have broader definitions, based on the exact implementation. -| `media_spend_items` | object | All cost data from the various media platforms is downloaded and stored in the the Media Spend Items and Media Spend Daily Spend collections. -| `media_spend_daily_spend` | object | This collection captures the daily spend for each campaign (and sometimes broken down by Ad Collective or Ad Id). +Collection | Type | Description +---------- | ----- | ------------- +`conversions` | object | This collection contains each identified conversion event, as configured in Unlocking Attribution and detected by the modeling. | +`conversion_touch_lookup` | object | This collection contains a cross-reference between each conversion and all the pre-conversion touches the end-user had. | +`touches` | object | A touch is defined as any interaction that a user had leading up to the conversion event. This generally means website visits, but can sometimes have broader definitions, based on the exact implementation. +`media_spend_items` | object | All cost data from the various media platforms is downloaded and stored in the the Media Spend Items and Media Spend Daily Spend collections. +`media_spend_daily_spend` | object | This collection captures the daily spend for each campaign (and is sometimes broken down by Ad Collective or Ad Id). ## Collection Properties Below are tables outlining the properties included in the collections listed above. From 4b1349880940d2ca068e7d171f5e3cb5f1462639 Mon Sep 17 00:00:00 2001 From: ugpeter <89007350+ugpeter@users.noreply.github.com> Date: Tue, 29 Aug 2023 14:10:49 +1000 Subject: [PATCH 17/22] Update src/connections/sources/catalog/cloud-apps/unlocking-attribution/index.md Co-authored-by: stayseesong <83784848+stayseesong@users.noreply.github.com> --- .../catalog/cloud-apps/unlocking-attribution/index.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/src/connections/sources/catalog/cloud-apps/unlocking-attribution/index.md b/src/connections/sources/catalog/cloud-apps/unlocking-attribution/index.md index 287395d7c9..141d5fb5d4 100644 --- a/src/connections/sources/catalog/cloud-apps/unlocking-attribution/index.md +++ b/src/connections/sources/catalog/cloud-apps/unlocking-attribution/index.md @@ -68,10 +68,10 @@ Property Name | Description ### conversion_touch_lookup -| Property Name | Description | -| ----------------------------- | ----------------------------------------------------------------------------------------------------- | -| `conversion` | The unique ID of the conversion event | -| `touch_id` | The unique ID of the specific touch | +Property Name | Description +--------------- | ------------ +`conversion` | The unique ID of the conversion event. +`touch_id` | The unique ID of the specific touch. ### touches From e3a2df6d41b51361fc25abc0421354bb071dde24 Mon Sep 17 00:00:00 2001 From: ugpeter <89007350+ugpeter@users.noreply.github.com> Date: Tue, 29 Aug 2023 14:11:01 +1000 Subject: [PATCH 18/22] Update src/connections/sources/catalog/cloud-apps/unlocking-attribution/index.md Co-authored-by: stayseesong <83784848+stayseesong@users.noreply.github.com> --- .../cloud-apps/unlocking-attribution/index.md | 30 +++++++++---------- 1 file changed, 15 insertions(+), 15 deletions(-) diff --git a/src/connections/sources/catalog/cloud-apps/unlocking-attribution/index.md b/src/connections/sources/catalog/cloud-apps/unlocking-attribution/index.md index 141d5fb5d4..88992ea8ec 100644 --- a/src/connections/sources/catalog/cloud-apps/unlocking-attribution/index.md +++ b/src/connections/sources/catalog/cloud-apps/unlocking-attribution/index.md @@ -75,21 +75,21 @@ Property Name | Description ### touches -| Property Name | Description | -| ----------------------------- | ----------------------------------------------------------------------------------------------------- | -| `timestamp` | The date/time that the touch occurred | -| `id` | The unique ID of this touch | -| `context_page_url` | The full URL of the page viewed | -| `context_page_path` | The path of the page viewed | -| `context_page_title` | The title of the page viewed | -| `context_page_referrer` | The referrer from where the user clicked from to get to this page | -| `context_campaign_source` | The contents of the utm_source query parameter in the URL | -| `context_campaign_medium` | The contents of the utm_medium query parameter in the URL | -| `context_campaign_name` | The contents of the utm_campaign query parameter in the URL | -| `context_campaign_content` | The contents of the utm_content query parameter in the URL | -| `context_campaign_terms` | The contents of the utm_terms query parameter in the URL | -| `campaign` | The unique ID of the “Media Spend Item” object which this touch was mapped to | -| `search_narrative` | The plain-English description of how this particular touch was mapped to campaign cost data | +Property Name | Description +--------------- | ------------- +`timestamp` | The time that the touch occurred. +`id` | The unique ID of the touch. +`context_page_url` | The full URL of the page viewed. +`context_page_path` | The path of the page viewed. +`context_page_title` | The title of the page viewed. +`context_page_referrer` | The referrer from where the user clicked from to get to the page. +`context_campaign_source` | The contents of the utm_source query parameter in the URL. +`context_campaign_medium` | The contents of the utm_medium query parameter in the URL. +`context_campaign_name` | The contents of the utm_campaign query parameter in the URL. +`context_campaign_content` | The contents of the utm_content query parameter in the URL. +`context_campaign_terms` | The contents of the utm_terms query parameter in the URL. +`campaign` | The unique ID of the “Media Spend Item” object which the touch was mapped to. +`search_narrative` | The description of how the touch was mapped to campaign cost data. ### media_spend_items From 10a28059d5db5bd2701ce437b672f1b38bfb0769 Mon Sep 17 00:00:00 2001 From: ugpeter <89007350+ugpeter@users.noreply.github.com> Date: Tue, 29 Aug 2023 14:11:21 +1000 Subject: [PATCH 19/22] Update src/connections/sources/catalog/cloud-apps/unlocking-attribution/index.md Co-authored-by: stayseesong <83784848+stayseesong@users.noreply.github.com> --- .../catalog/cloud-apps/unlocking-attribution/index.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/src/connections/sources/catalog/cloud-apps/unlocking-attribution/index.md b/src/connections/sources/catalog/cloud-apps/unlocking-attribution/index.md index 88992ea8ec..1249cbd5bd 100644 --- a/src/connections/sources/catalog/cloud-apps/unlocking-attribution/index.md +++ b/src/connections/sources/catalog/cloud-apps/unlocking-attribution/index.md @@ -116,11 +116,11 @@ Each row in the Media Spend Items collection represent a unique combination of t ### media_spend_daily_spend -| Property Name | Description | -| ----------------------------- | ----------------------------------------------------------------------------------------------------- | -| `campaign` | The unique ID of the media_spend_items item, which this spend row corresponds to | -| `date_start` | The date of this spending item | -| `spend` | The amount of spend on that day | +Property Name | Description +--------------- | ------------- +`campaign` | The unique ID of the media_spend_items item, which the spend row corresponds to. +`date_start` | The date of the spending item. +`spend` | The amount spent on that day. --- From b31bbfa1e64716391a683289462c21bae939be3d Mon Sep 17 00:00:00 2001 From: ugpeter <89007350+ugpeter@users.noreply.github.com> Date: Tue, 29 Aug 2023 14:12:02 +1000 Subject: [PATCH 20/22] Update src/connections/sources/catalog/cloud-apps/unlocking-attribution/index.md Co-authored-by: stayseesong <83784848+stayseesong@users.noreply.github.com> --- .../cloud-apps/unlocking-attribution/index.md | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/src/connections/sources/catalog/cloud-apps/unlocking-attribution/index.md b/src/connections/sources/catalog/cloud-apps/unlocking-attribution/index.md index 1249cbd5bd..c4db8ab1b7 100644 --- a/src/connections/sources/catalog/cloud-apps/unlocking-attribution/index.md +++ b/src/connections/sources/catalog/cloud-apps/unlocking-attribution/index.md @@ -102,15 +102,15 @@ All cost data from the various media platforms is downloaded and stored in the t Each row in the Media Spend Items collection represent a unique combination of the above 4 attributes. After matching a touch against a campaign, the `campaign` identifier in the `touches` collection points to a row from this collection. -| Property Name | Description | -| ----------------------------- | ----------------------------------------------------------------------------------------------------- | -| `campaign_name` | The name of the campaign | -| `campaign_id` | The unique ID of the campaign, as set by the paid media platform | -| `id` | The unique ID of this item | -| `ad_collective_name` | The name of the Ad Collective | -| `ad_collective_id` | The unique ID of the Ad Collective, as set by the paid media platform | -| `media_source` | The platform of this media item | -| `type` | The type of this media item (Paid, Organic) | +Property Name | Description +--------------- | -------------- +`campaign_name` | The name of the campaign. +`campaign_id` | The unique ID of the campaign. This is set by the paid media platform. +`id` | The unique ID of the item. +`ad_collective_name` | The name of the Ad Collective. +`ad_collective_id` | The unique ID of the Ad Collective. This is set by the paid media platform. +`media_source` | The platform of the media item. +`type` | The type of the media item (Paid, Organic). ### media_spend_daily_spend From 1dbfff1d9e4a56276f5ba5b7e0ffb7e41e71ce84 Mon Sep 17 00:00:00 2001 From: peterikladious Date: Tue, 29 Aug 2023 14:23:00 +1000 Subject: [PATCH 21/22] Updates based on feedback from Segment --- .../catalog/cloud-apps/unlocking-attribution/index.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/src/connections/sources/catalog/cloud-apps/unlocking-attribution/index.md b/src/connections/sources/catalog/cloud-apps/unlocking-attribution/index.md index c4db8ab1b7..acbcda94be 100644 --- a/src/connections/sources/catalog/cloud-apps/unlocking-attribution/index.md +++ b/src/connections/sources/catalog/cloud-apps/unlocking-attribution/index.md @@ -4,7 +4,12 @@ title: Unlocking Attribution Source The [Unlocking Attribution](https://unlockinggrowth.co/products/?utm_source=segmentio&utm_medium=docs&utm_campaign=partners) source is a powerful solution designed to model attribution data, aiding marketers in identifying the most effective inbound channels for driving conversions. This documentation will guide you through the process of setting up and utilizing the "Unlocking Attribution" source within your Twilio Segment environment. Unlocking Attribution is built on top of your pre-existing Segment implementation, ensuring you can be up and running in under an hour. -This is an [Object Cloud Source](/docs/connections/sources/#object-cloud-sources) which can import data into your Segment warehouse. This means it can be used both within the Unlocking Attribution tool itself, or from the analytics tools which read from your data warehouse. +Additionally, it provides a way to bring in critical event and object data from key systems such as: +- Marketo Event Streaming - This ensures that all key events occurring in Marketo are fed in real-time to Segment. These include events such as "Email Sent", "Email Opened", "Link Clicked", etc +- LinkedIn, Twitter, Capterra Paid Media Data - Similar to the Segment-provided Google and Facebook paid media sources, this brings in the paid media spend data for these other paid media networks +- SaaSOptics Object Source - Bringing in object data from SaaSOptics + +This source generates both [Events and Objects](docs/connections/sources). Event data can be streamed into your downstream tools and written to the data warehouse while the Object sources can be written to your data warehouse. This means this data can be used both within the Unlocking Attribution tool itself, or from reporting/analytics tools which read from your data warehouse. This source is maintained by Unlocking Attribution. For any issues with the source, [contact their Support team](mailto:support@unlockinggrowth.co). From 85ccd99cb900e638a14906fbe7185624b16b3cc9 Mon Sep 17 00:00:00 2001 From: peterikladious Date: Fri, 1 Sep 2023 10:31:11 +1000 Subject: [PATCH 22/22] Updated to factor in requests from Segment team --- .../cloud-apps/unlocking-attribution/index.md | 14 +++++--------- 1 file changed, 5 insertions(+), 9 deletions(-) diff --git a/src/connections/sources/catalog/cloud-apps/unlocking-attribution/index.md b/src/connections/sources/catalog/cloud-apps/unlocking-attribution/index.md index acbcda94be..c347bd31ae 100644 --- a/src/connections/sources/catalog/cloud-apps/unlocking-attribution/index.md +++ b/src/connections/sources/catalog/cloud-apps/unlocking-attribution/index.md @@ -98,21 +98,17 @@ Property Name | Description ### media_spend_items -All cost data from the various media platforms is downloaded and stored in the the Media Spend Items and Media Spend Daily Spend collections. Regardless of the media platform, the data is formatted to have the following key unique identifiers/attributes: +All cost data from the various media platforms is downloaded and stored in the the Media Spend Items and Media Spend Daily Spend collections. Regardless of the media platform, the data is formatted to have a consistent set of key identifiers and attributes as shown in the table below. -* **Campaign Name** - The name of the campaign as defined the media platform. In some platforms, this could be derived from the “Category” field or “Campaign Group” field -* **Ad Collective Name** - The name of the Ad Collective (also known as Ad Set, or Ad Group across various platforms) -* **Campaign Id** - The unique ID of the campaign, as determined by the media platform -* **Ad Collective Id** - The unique ID of the Ad Collective, as determined by the media platform -Each row in the Media Spend Items collection represent a unique combination of the above 4 attributes. After matching a touch against a campaign, the `campaign` identifier in the `touches` collection points to a row from this collection. +Each row in the Media Spend Items collection represent a unique combination of the 4 key attributes(`campaign_name`,`ad_collective_name`, `campaign_id`, `ad_collective_id`). After matching a touch against a campaign, the `campaign` identifier in the `touches` collection points to a row from this collection. Property Name | Description --------------- | -------------- -`campaign_name` | The name of the campaign. -`campaign_id` | The unique ID of the campaign. This is set by the paid media platform. +`campaign_name` | The name of the campaign as defined the media platform. In some platforms, this could be derived from the “Category” field or “Campaign Group” field +`campaign_id` | The unique ID of the campaign, as determined by the media platform `id` | The unique ID of the item. -`ad_collective_name` | The name of the Ad Collective. +`ad_collective_name` | The name of the Ad Collective (also known as Ad Set, or Ad Group across various platforms) `ad_collective_id` | The unique ID of the Ad Collective. This is set by the paid media platform. `media_source` | The platform of the media item. `type` | The type of the media item (Paid, Organic).