You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: src/connections/sources/catalog/cloud-apps/unlocking-attribution/index.md
+26-30Lines changed: 26 additions & 30 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,38 +2,35 @@
2
2
title: Unlocking Attribution Source
3
3
---
4
4
5
-
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.
5
+
The [Unlocking Attribution](https://unlockinggrowth.co/products/?utm_source=segmentio&utm_medium=docs&utm_campaign=partners){:target="_blank"} 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.
6
6
7
7
Additionally, it provides a way to bring in critical event and object data from key systems such as:
8
8
- 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
9
9
- 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
10
10
- SaaSOptics Object Source - Bringing in object data from SaaSOptics
11
11
12
-
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.
12
+
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.
13
13
14
-
This source is maintained by Unlocking Attribution. For any issues with the source, [contact their Support team](mailto:[email protected]).
14
+
This source is maintained by Unlocking Attribution. For any issues with the source, [contact the Unlocking Attribution team](mailto:[email protected]).
15
15
16
-
> info ""
17
-
> 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:[email protected]).
16
+
> info ""
17
+
> 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:[email protected]).
18
18
19
19
## Getting Started
20
-
21
-
22
20
1. Navigate to **Connections > Catalog** and select the **Sources** tab of the catalog.
23
21
2. Search for *Unlocking Attribution* in the Sources Catalog.
24
22
3. Select **Unlocking Attribution** and click **Add Source**.
25
23
4. Give the Source a nickname.
26
24
- 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).
27
-
28
-
5. Enter the configuration setting.
25
+
5. Enter the configuration settings.
29
26
6. Click **Add Source** to save your settings.
30
27
7. Navigate to **Settings > Workspace Settings**
31
28
8. Select the **Access Management** tab.
32
29
7. Select the **Tokens** tab.
33
-
8. Click the **+ Create Token**.
30
+
8. Click **+ Create Token**.
34
31
9. Enter a description such as *Unlocking Attribution*, select **Workspace Owner** and click **Create**.
35
32
10. Copy the token that is presented on the screen.
36
-
11. Switch to your account in Unlocking Attribution and within the Onboarding Wizard, paste the token you copied.
33
+
11. Switch to your account in Unlocking Attribution and within the onboarding wizard, paste the token you copied.
37
34
12. Click **Connect** and follow the remaining steps within the onboarding wizard.
38
35
39
36
@@ -50,10 +47,10 @@ The source syncs and warehouse syncs are independent processes. Source runs pull
50
47
Collections are the groupings of resources that Segment pulls from your source. In your warehouse, each collection gets its own table.
51
48
52
49
Collection | Type | Description
53
-
---------- | ----- | -------------
54
-
`conversions` | object | This collection contains each identified conversion event, as configured in Unlocking Attribution and detected by the modeling. |
55
-
`conversion_touch_lookup` | object | This collection contains a cross-reference between each conversion and all the pre-conversion touches the end-user had. |
56
-
`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.
50
+
---------- | ---- | ----------
51
+
`conversions` | object | This collection contains each identified conversion event, as configured in Unlocking Attribution and detected by the modeling.
52
+
`conversion_touch_lookup` | object | This collection contains a cross-reference between each conversion and all the pre-conversion touches the end-user had.
53
+
`touches` | object | A touch is 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.
57
54
`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.
58
55
`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).
59
56
@@ -65,8 +62,8 @@ Below are tables outlining the properties included in the collections listed abo
65
62
Property Name | Description
66
63
---------------- | ------------
67
64
`id` | The unique ID of the conversion event.
68
-
`anonymous_id` | The anonymous_id of the user who performed the conversion event.
69
-
`user_id` | The user_id of the user who performed the conversion event.
65
+
`anonymous_id` | The `anonymous_id` of the user who performed the conversion event.
66
+
`user_id` | The `user_id` of the user who performed the conversion event.
70
67
`conversiontype` | The name of the conversion event.
71
68
`timestamp` | The date and time that the conversion event occurred.
72
69
`value` | The value of the conversion event. This is typically revenue.
@@ -88,38 +85,37 @@ Property Name | Description
88
85
`context_page_path` | The path of the page viewed.
89
86
`context_page_title` | The title of the page viewed.
90
87
`context_page_referrer` | The referrer from where the user clicked from to get to the page.
91
-
`context_campaign_source` | The contents of the utm_source query parameter in the URL.
92
-
`context_campaign_medium` | The contents of the utm_medium query parameter in the URL.
93
-
`context_campaign_name` | The contents of the utm_campaign query parameter in the URL.
94
-
`context_campaign_content` | The contents of the utm_content query parameter in the URL.
95
-
`context_campaign_terms` | The contents of the utm_terms query parameter in the URL.
96
-
`campaign` | The unique ID of the “Media Spend Item” object which the touch was mapped to.
88
+
`context_campaign_source` | The contents of the `utm_source` query parameter in the URL.
89
+
`context_campaign_medium` | The contents of the `utm_medium` query parameter in the URL.
90
+
`context_campaign_name` | The contents of the `utm_campaign` query parameter in the URL.
91
+
`context_campaign_content` | The contents of the `utm_content` query parameter in the URL.
92
+
`context_campaign_terms` | The contents of the `utm_terms` query parameter in the URL.
93
+
`campaign` | The unique ID of the **Media Spend Item** object which the touch was mapped to.
97
94
`search_narrative` | The description of how the touch was mapped to campaign cost data.
98
95
99
96
100
97
### media_spend_items
101
-
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.
98
+
All cost data from the various media platforms are 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.
102
99
103
-
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.
100
+
Each row in the Media Spend Items collection represents 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.
104
101
105
102
106
103
Property Name | Description
107
104
--------------- | --------------
108
-
`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
109
-
`campaign_id` | The unique ID of the campaign, as determined by the media platform
105
+
`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
106
+
`campaign_id` | The unique ID of the campaign, as determined by the media platform.
110
107
`id` | The unique ID of the item.
111
-
`ad_collective_name` | The name of the Ad Collective (also known as Ad Set, or Ad Group across various platforms)
108
+
`ad_collective_name` | The name of the Ad Collective (also known as Ad Set, or Ad Group across various platforms).
112
109
`ad_collective_id` | The unique ID of the Ad Collective. This is set by the paid media platform.
113
110
`media_source` | The platform of the media item.
114
111
`type` | The type of the media item (Paid, Organic).
115
112
116
113
117
114
### media_spend_daily_spend
118
115
119
-
120
116
Property Name | Description
121
117
--------------- | -------------
122
-
`campaign` | The unique ID of the media_spend_items item, which the spend row corresponds to.
118
+
`campaign` | The unique ID of the `media_spend_items` item, which the spend row corresponds to.
0 commit comments