Skip to content

Littledata docs update #1524

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Apr 21, 2021
Merged

Littledata docs update #1524

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
30dd680
Add subscription_revenue
edwardupton Apr 21, 2021
a9908e4
heading case
edwardupton Apr 21, 2021
37c1aa6
Merge branch 'master' into littledata-docs-update
edwardupton Apr 21, 2021
ed3d46e
typo
edwardupton Apr 21, 2021
1407a54
fix notes, revert title case
markzegarelli Apr 21, 2021
6ad938d
fix notes [netlify-ignore]
markzegarelli Apr 21, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
80 changes: 41 additions & 39 deletions src/connections/sources/catalog/libraries/website/shopify-littledata/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ Here's an architecture diagram that shows how the Littledata app mediates data f
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.
![](images/kvjNx4M.png)

## Device-mode Events
## Device-mode events

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.

Expand All @@ -50,12 +50,12 @@ Below is a table of events that **Shopify by Littledata** sends to Segment throu
| Product Viewed | A user has viewed a product page |
| Products Searched | A user has searched for products (with search `query`) |
| Registration Viewed | A user has viewed the /account/register page |
| Thank you Page Viewed | A user has viewed the thank you page after completing an order \* |
| Thank you Page Viewed | A user has viewed the thank you page after completing an order\* |

> info ""
> 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.

## Cloud-mode Events
## Cloud-mode events

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.

Expand Down Expand Up @@ -88,7 +88,7 @@ In the Littledata application you can choose which of the following fields you w

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

## Identify Calls
## Identify calls

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.

Expand Down Expand Up @@ -119,11 +119,11 @@ All events (device-mode and cloud-mode) contain the Google Analytics `clientId`

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.

## Alias Calls
## Alias calls

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

## Subscription e-commerce Events
## Subscription events

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

Expand All @@ -137,40 +137,42 @@ Additional events available through Littledata's [ReCharge connection](https://w
| Subscription Created | A customer has created a subscription (with `status`, `order_interval_frequency` and `order_interval_unit`) |
| Subscription Updated | A customer has updated a subscription (with `status`, `order_interval_frequency` and `order_interval_unit`) |

## Event Properties
## Event properties

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

| Property | Description | Property Type |
| -------------------------------------- | -------------------------------------------------------------- | ------------- |
| `affiliation` | The affiliation of the order | String |
| `cart_id` | The ID of the Shopify cart | String |
| `checkoutId` | The ID of the checkout session | String |
| `context.ip` | The user's IP address | String |
| `context['Google Analytics'].clientId` | The user's Google Analytics Client ID | String |
| `context['Google Analytics'].geoid` | The user's location | String |
| `coupon` | Comma-separated string of discount coupons used, if applicable | String |
| `currency` | The currency of the order | String |
| `discount` | The discounted amount | Float |
| `email` | Shopify email address, or email submitted on a storefront form | String |
| `order_id` | The ID of the order | String |
| `payment_method` | The payment method chosen for checkout | String |
| `presentment_currency` | The user's local currency | String |
| `presentment_total` | The order total in local currency | String |
| `products` | A list of all the product at that step of the funnel \* | Array |
| `revenue` | Product revenue (excluding discounts, shipping and tax) | Float |
| `sent_from` | A unique property to identify events sent by Littledata | String |
| `shipping_method` | The shipping method chosen for checkout | String |
| `shipping` | The shipping cost | Float |
| `step` | The checkout step | Integer |
| `subtotal` | Order total after discounts but before taxes and shipping | Float |
| `tax` | The amount of tax on the order | Float |
| `total` | The total value of the order | Float |
| `userId` | Chosen user identifier, defaulting to Shopify Customer ID | Double |

\* 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.

## Product Properties
| Property | Description | Property Type |
| -------------------------------------- | ------------------------------------------------------------------------ | ------------- |
| `affiliation` | The affiliation of the order | String |
| `cart_id` | The ID of the Shopify cart | String |
| `checkoutId` | The ID of the checkout session | String |
| `context.uip` | The user's IP address | String |
| `context['Google Analytics'].clientId` | The user's Google Analytics Client ID | String |
| `context['Google Analytics'].geoid` | The user's location | String |
| `coupon` | Comma-separated string of discount coupons used, if applicable | String |
| `currency` | The currency of the order | String |
| `discount` | The discounted amount | Float |
| `email` | Shopify email address, or email submitted on a storefront form | String |
| `order_id` | The ID of the order | String |
| `payment_method` | The payment method chosen for checkout | String |
| `presentment_currency` | The user's local currency | String |
| `presentment_total` | The order total in local currency | String |
| `products` | A list of all the product at that step of the funnel | Array |
| `revenue` | Product revenue (excluding discounts, shipping and tax) * | Float |
| `sent_from` | A unique property to identify events sent by Littledata | String |
| `shipping_method` | The shipping method chosen for checkout | String |
| `shipping` | The shipping cost | Float |
| `step` | The checkout step | Integer |
| `subscription_revenue` | The revenue associated with a [Subscription Event](#subscription-events) | Float |
| `subtotal` | Order total after discounts but before taxes and shipping | Float |
| `tax` | The amount of tax on the order | Float |
| `total` | The total value of the order | Float |
| `userId` | Chosen user identifier, defaulting to Shopify Customer ID | String |

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

## Product properties

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

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

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.

## Advanced device-mode settings
## Advanced Device-mode settings

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

Expand Down
43 changes: 43 additions & 0 deletions src/personas/product-limits.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
---
title: Limits
---




These rate limits were added to our product documentation on December 9, 2020.

## Summary of Limits

| Name | Limit |
| ------------------------------------------- | ----------------------------------------------------------- |
| Inbound Data Throughput | 1000 events per second |
| Inbound Historical Replay Throughput | 1000 events per second |
| Outbound Downstream Destination Rate Limits | Reduced retries when failures exceed 1000 events per second |
| Profile API throughput | 100 requests per second |
| Identity Merges | 100 merges |
| Identity Mappings | 1000 mappings |

## Inbound Data Throughput

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 friends@segment.com with details on your use case and estimated throughput.

## Inbound Historical Replay Throughput

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 friends@segment.com with details on your use case.

## Outbound Downstream Destination Rate Limits

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.

## Profile API throughput

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 friends@segment.com with details on your use case and estimated throughput.

## Identity Merges

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.

## Identity Mappings

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.