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/libraries/website/shopify-littledata/index.md
+41-39Lines changed: 41 additions & 39 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -35,7 +35,7 @@ Here's an architecture diagram that shows how the Littledata app mediates data f
35
35
7. Segment's **analytics.js** library, Littledata **tracking script** and **webhooks** will be automatically applied to the store and the installation process will then be complete.
36
36
37
37
38
-
## Device-mode Events
38
+
## Device-mode events
39
39
40
40
Below is a table of events that **Shopify by Littledata** sends to Segment through the analytics.js library. These events will show up as tables in your warehouse, and as regular events in your other Destinations supporting device-mode.
41
41
@@ -50,12 +50,12 @@ Below is a table of events that **Shopify by Littledata** sends to Segment throu
50
50
| Product Viewed | A user has viewed a product page |
51
51
| Products Searched | A user has searched for products (with search `query`) |
52
52
| Registration Viewed | A user has viewed the /account/register page |
53
-
| Thank you Page Viewed | A user has viewed the thank you page after completing an order\*|
53
+
| Thank you Page Viewed | A user has viewed the thank you page after completing an order\*|
54
54
55
-
> info ""
55
+
> note ""
56
56
> \* This is less reliable than the de-duplicated `Order Completed` event sent from the Littledata servers, but you can use it in device-mode destinations to trigger a conversion. The `payment_method` and `shipping_method` properties are not available with this event.
57
57
58
-
## Cloud-mode Events
58
+
## Cloud-mode events
59
59
60
60
Below is a table of events that **Shopify by Littledata** sends to Segment from Littledata's servers. These events appear as tables in your warehouse, and as regular events in your other Destinations that support cloud-mode. They include the `anonymousId` that links them to the device-mode events where the event was part of a previous user session, or associated with a `userId` that was previously linked with an `anonymousId`. See Littledata's [troubleshooting guide on attribution](https://blog.littledata.io/help/posts/troubleshooting-marketing-attribution-for-shopify/) for more details.
61
61
@@ -88,7 +88,7 @@ In the Littledata application you can choose which of the following fields you w
88
88
89
89
For [Segment Personas](/docs/personas/) we also send `shopify_customer_id` as an [externalID](/docs/personas/identity-resolution/externalids/) for advanced matching.
90
90
91
-
## Identify Calls
91
+
## Identify calls
92
92
93
93
For every event where there is an identifiable Shopify customer (from both the device-mode and cloud-mode) Littledata also sends an Identify call. This happens when the customer logs into the storefront, on the last step of the checkout, with the order, and also after purchase with any customer update in Shopify admin.
94
94
@@ -119,11 +119,11 @@ All events (device-mode and cloud-mode) contain the Google Analytics `clientId`
119
119
120
120
Email marketing platforms such as [Klaviyo](/docs/connections/destinations/catalog/klaviyo/#server-side-track), [Iterable](/docs/connections/destinations/catalog/iterable/#track) and [Hubspot](/docs/connections/destinations/catalog/hubspot/#server) require an email property with any server-side event in order to associate events with a customer (they cannot use an `anonymousId`). Littledata adds that `email` property whenever an email address is set in the user `traits()` object (in device-mode) or from the Shopify customer record (in cloud-mode). Iterable can also [receive cookie values](#cookiesToTrack) with the Order Completed event.
121
121
122
-
## Alias Calls
122
+
## Alias calls
123
123
124
124
To support seamless customer tracking the [Mixpanel](/docs/connections/destinations/catalog/mixpanel/#alias), [Vero](/docs/connections/destinations/catalog/vero/#alias) and [KISSMetrics](/docs/connections/destinations/catalog/kissmetrics/#alias) destinations, Littledata ensures the pre-checkout `anonymousId` is added as an alias of the `userId` (used from checkout step 2 onwards).
125
125
126
-
## Subscription e-commerce Events
126
+
## Subscription events
127
127
128
128
Additional events available through Littledata's [ReCharge connection](https://www.littledata.io/connections/recharge), and available in cloud-mode destinations.
129
129
@@ -137,40 +137,42 @@ Additional events available through Littledata's [ReCharge connection](https://w
137
137
| Subscription Created | A customer has created a subscription (with `status`, `order_interval_frequency` and `order_interval_unit`) |
138
138
| Subscription Updated | A customer has updated a subscription (with `status`, `order_interval_frequency` and `order_interval_unit`) |
139
139
140
-
## Event Properties
140
+
## Event properties
141
141
142
142
The list below outlines the properties included in the events listed above.
|`sent_from`| A unique property to identify events sent by Littledata | String |
163
-
|`shipping_method`| The shipping method chosen for checkout | String |
164
-
|`shipping`| The shipping cost | Float |
165
-
|`step`| The checkout step | Integer |
166
-
|`subtotal`| Order total after discounts but before taxes and shipping | Float |
167
-
|`tax`| The amount of tax on the order | Float |
168
-
|`total`| The total value of the order | Float |
169
-
|`userId`| Chosen user identifier, defaulting to Shopify Customer ID | Double |
170
-
171
-
\* Prior to 1st February 2021, `products` on Product Added and Product Removed events was [only the single product](https://blog.littledata.io/help/posts/segment-changed-schema-for-product-added-and-product-removed/), not the whole cart.
|`sent_from`| A unique property to identify events sent by Littledata | String |
163
+
|`shipping_method`| The shipping method chosen for checkout | String |
164
+
|`shipping`| The shipping cost | Float |
165
+
|`step`| The checkout step | Integer |
166
+
|`subscription_revenue`| The revenue associated with a [Subscription Event](#subscription-events)| Float |
167
+
|`subtotal`| Order total after discounts but before taxes and shipping | Float |
168
+
|`tax`| The amount of tax on the order | Float |
169
+
|`total`| The total value of the order | Float |
170
+
|`userId`| Chosen user identifier, defaulting to Shopify Customer ID | String |
171
+
172
+
> note ""
173
+
> \*`revenue` is available only with the Order Completed event, and only if the store opts in via the Littledata application. Revenue is a reserved property in many Segment destinations. Opting in will override the `total` property sent to Google Analytics.
174
+
175
+
## Product properties
174
176
175
177
Each item in the `products` array, or Product Viewed and Product Added events, will have the following properties
176
178
@@ -196,7 +198,7 @@ Each item in the `products` array, or Product Viewed and Product Added events, w
196
198
197
199
With a [Littledata Plus plan](https://www.littledata.io/app/enterprise) you can import all Shopify orders and refunds from before you started using Segment, to sync with destinations that support timestamped events (for example, a data warehouse). This enables you to build a complete customer history in your chosen destination.
198
200
199
-
## Advanced device-mode settings
201
+
## Advanced Device-mode settings
200
202
201
203
You can edit the LittledataLayer object in your Shopify theme to manually change these advanced settings. For more information, see the [Shopify tracker GitHub repository](https://github.com/littledata/shopify-tracker#segment-configuration).
| Inbound Data Throughput | 1000 events per second |
15
+
| Inbound Historical Replay Throughput | 1000 events per second |
16
+
| Outbound Downstream Destination Rate Limits | Reduced retries when failures exceed 1000 events per second |
17
+
| Profile API throughput | 100 requests per second |
18
+
| Identity Merges | 100 merges |
19
+
| Identity Mappings | 1000 mappings |
20
+
21
+
## Inbound Data Throughput
22
+
23
+
If within a ten minute period a Customer’s sources (in aggregate) send more than 600,000 events (average of 1,000 events per second) without prior arrangement, Segment reserves the right to queue any additional events and process those at a rate that does not exceed 600,000 events in any ten minute period. Any requests to raise that limit must be made in writing with Segment. Please reach out to [email protected] with details on your use case and estimated throughput.
24
+
25
+
## Inbound Historical Replay Throughput
26
+
27
+
Similar to live data ingestion, any requests to replay historical customer data into Personas will be capped at a rate of 1000 events per second. Replays are initiated by the Segment support team. If you have a need for a higher replay throughput, please reach out to [email protected] with details on your use case.
28
+
29
+
## Outbound Downstream Destination Rate Limits
30
+
31
+
Most destinations have their own rate limits that Segment cannot control. In some instances, Segment is able to ingest and attempt to deliver data faster than the downstream destination is able to accept data. Outbound requests to a destination may also fail for other reasons outside of Segment’s control. When requests to downstream destinations fail, Segment makes additional attempts to deliver the data (retries). However, when more than 1,000 requests per second to a downstream destination fail or when the failure rate for a downstream destination exceeds 50% for more than 72 hours, Segment reserves the right to reduce the number of retries until the condition is resolved.
32
+
33
+
## Profile API throughput
34
+
35
+
If a Customer sends more than 100 requests a second per space to the Profile API, Segment will return a 429 rate-limiting error. Any requests to raise that limit must be made in writing with Segment. Please reach out to [email protected] with details on your use case and estimated throughput.
36
+
37
+
## Identity Merges
38
+
39
+
Personas supports up to 100 merges per profile in its identity graph. A merge occurs when two existing profile are joined together by a common external_id. For example, if a user starts their journey on mobile, and then signs in via a web application, those two user profiles are joined together by a common identifier like a user_id. Messages that attempt additional merges are usually a sign of a corrupt profile and are dropped.
40
+
41
+
## Identity Mappings
42
+
43
+
Personas supports up to 1000 mappings per profile in its identity graph. Mappings are external id values like a user_id, email, mobile advertising id, or any custom id's. Messages that attempt to add additional mappings are usually a sign of a corrupt profile and are dropped. Note that this limit counts mappings across all merged profiles.
0 commit comments