Skip to content

Commit f78d55b

Browse files
committed
Merge branch 'master' into littledata-docs-update
2 parents 00232d9 + f06b8e4 commit f78d55b

File tree

4 files changed

+65
-15
lines changed

4 files changed

+65
-15
lines changed

src/_layouts/default.html

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,7 @@
8383
Production: https://app.segment.com/segment_prod/sources/segment_docs_v2_prod
8484
Everything else: https://app.segment.com/segment-engineering/sources/segment_docs
8585
{%- endcomment -%}
86-
{%- if jekyll.environment == "production" -%}
86+
{%- if site.env.CONTEXT == "production" -%}
8787
{%- assign write_key = "QAKKJEtNsXpsNfCCBeWCLNxkaaLO7pgp" -%}
8888
{%- else -%}
8989
{%- assign write_key = "f5c1iWVVwikUDoh5NuVq0G52EPFrMmrX" -%}
@@ -118,7 +118,6 @@
118118
{%- comment -%}
119119
Consent Manager
120120
{%- endcomment -%}
121-
122121
<script>
123122
window.consentManagerConfig = function (exports) {
124123
var React = exports.React

src/connections/destinations/catalog/google-analytics/index.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -621,8 +621,16 @@ If you want to send UTM parameters to Google Analytics using one of the Segment
621621

622622
Your UTM params need to be passed in the `context` object in `context.campaign`. For Google Analytics `campaign.name`, `campaign.source` and `campaign.medium` all need to be sent together for things to show up in reports. The other two params (`campaign.term` and `campaign.content`) are both optional, but will be forwarded to GA if you send them to Segment.
623623

624+
### Measurement Protocol Parameters
624625

625-
---
626+
Google Analytics uses a reserved set of [Measurement Protocol Parameters](https://developers.google.com/analytics/devguides/collection/protocol/v1/parameters) which are automatically collected by the device-mode Google Analytics tracker.
627+
628+
To include Measurement Protocol Parameters when sending server-side events to Google Analytics:
629+
630+
1. Collect the value of the parameter as a Segment trait or property
631+
2. Configure the Segment Google Analytics destination to [map the trait or property](#map-traits-or-properties-to-measurement-protocol-params) to a specific Measurement Protocol Parameter key
632+
633+
Segment supports the `plt`, `pdt`, `gclid`, `dt`, and `cid` Measurement Protocol Parameters.
626634

627635

628636
## Features

src/connections/sources/catalog/libraries/website/shopify-littledata/index.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ Here's an architecture diagram that shows how the Littledata app mediates data f
3535
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.
3636
![](images/kvjNx4M.png)
3737

38-
## Device-mode Events
38+
## Device-mode events
3939

4040
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.
4141

@@ -50,11 +50,11 @@ Below is a table of events that **Shopify by Littledata** sends to Segment throu
5050
| Product Viewed | A user has viewed a product page |
5151
| Products Searched | A user has searched for products (with search `query`) |
5252
| 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\* |
5454

55-
> info "" \* 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.
55+
> note "" \* 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.
5656
57-
## Cloud-mode Events
57+
## Cloud-mode events
5858

5959
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.
6060

@@ -76,7 +76,7 @@ Below is a table of events that **Shopify by Littledata** sends to Segment from
7676
| Product Added | A user has added a product to the cart, and left it in the cart for more than 10 seconds |
7777
| Product Removed | A user has removed a product from the cart |
7878

79-
## User Identity
79+
## User identity
8080

8181
In the Littledata application you can choose which of the following fields you want to send as the `userId` for known customers:
8282

@@ -87,7 +87,7 @@ In the Littledata application you can choose which of the following fields you w
8787

8888
For [Segment Personas](/docs/personas/) we also send `shopify_customer_id` as an [externalID](/docs/personas/identity-resolution/externalids/) for advanced matching.
8989

90-
## Identify Calls
90+
## Identify calls
9191

9292
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.
9393

@@ -118,11 +118,11 @@ All events (device-mode and cloud-mode) contain the Google Analytics `clientId`
118118

119119
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.
120120

121-
## Alias Calls
121+
## Alias calls
122122

123123
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).
124124

125-
## Subscription Events
125+
## Subscription events
126126

127127
Additional events available through Littledata's [ReCharge connection](https://www.littledata.io/connections/recharge), and available in cloud-mode destinations.
128128

@@ -136,7 +136,7 @@ Additional events available through Littledata's [ReCharge connection](https://w
136136
| Subscription Created | A customer has created a subscription (with `status`, `order_interval_frequency` and `order_interval_unit`) |
137137
| Subscription Updated | A customer has updated a subscription (with `status`, `order_interval_frequency` and `order_interval_unit`) |
138138

139-
## Event Properties
139+
## Event properties
140140

141141
The list below outlines the properties included in the events listed above.
142142

@@ -168,9 +168,9 @@ The list below outlines the properties included in the events listed above.
168168
| `total` | The total value of the order | Float |
169169
| `userId` | Chosen user identifier, defaulting to Shopify Customer ID | String |
170170

171-
\* `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.
171+
> note "" \* `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.
172172
173-
## Product Properties
173+
## Product properties
174174

175175
Each item in the `products` array, or Product Viewed and Product Added events, will have the following properties
176176

@@ -196,7 +196,7 @@ Each item in the `products` array, or Product Viewed and Product Added events, w
196196

197197
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.
198198

199-
## Advanced Device-mode Settings
199+
## Advanced Device-mode settings
200200

201201
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).
202202

src/personas/product-limits.md

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
---
2+
title: Limits
3+
---
4+
5+
6+
7+
8+
These rate limits were added to our product documentation on December 9, 2020.
9+
10+
## Summary of Limits
11+
12+
| Name | Limit |
13+
| ------------------------------------------- | ----------------------------------------------------------- |
14+
| 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

Comments
 (0)