Skip to content

Commit 0b5342d

Browse files
author
markzegarelli
authored
Merge pull request #1434 from segmentio/littledata-docs-update
Add product properties for Littledata
2 parents ddeab82 + 57ac887 commit 0b5342d

File tree

1 file changed

+35
-33
lines changed
  • src/connections/sources/catalog/libraries/website/shopify-littledata

1 file changed

+35
-33
lines changed

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

Lines changed: 35 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Littledata is a smart analytics app that automates e-commerce tracking. Littleda
1010

1111
Littledata is available as an independent [Shopify App](https://apps.shopify.com/segment-com-by-littledata). When you install the Littledata app on your store, Littledata does two things:
1212

13-
1. It inserts a smart tracking script to your store's front end. You can use this script with any custom Shopify site, and uses analytics.js under the hood to send data in a spec-compliant manner to Segment.
13+
1. It inserts a smart tracking script to your store's front end. You can use this script with any Shopify site, and uses Analytics.js under the hood to send data in a spec-compliant manner to Segment.
1414

1515
2. The app also sets up server-side webhook forwarding to ensure 100% accuracy of important Customer and Order data.
1616

@@ -39,21 +39,20 @@ Here's an architecture diagram that shows how the Littledata app mediates data f
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

42-
| Event Name | Description |
43-
| --------------------- | --------------------------------------------------------------------- |
44-
| Cart Viewed | A user has viewed the /cart page |
45-
| Page Viewed | A user has viewed any page |
46-
| Product Clicked | A user has clicked a product within a product list |
47-
| Product Image Clicked | A user has clicked a product image |
48-
| Product List Viewed | A user has viewed a product as they scroll down the collection page |
49-
| Product Shared | A user has shared a product through social links |
50-
| Product Viewed | A user has viewed a product page |
51-
| Products Searched | A user has searched for products (with search `query`) |
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 \* |
54-
55-
> note ""
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.
42+
| Event Name | Description |
43+
| --------------------- | ------------------------------------------------------------------- |
44+
| Cart Viewed | A user has viewed the /cart page |
45+
| Page Viewed | A user has viewed any page |
46+
| Product Clicked | A user has clicked a product within a product list |
47+
| Product Image Clicked | A user has clicked a product image |
48+
| Product List Viewed | A user has viewed a product as they scroll down the collection page |
49+
| Product Shared | A user has shared a product through social links |
50+
| Product Viewed | A user has viewed a product page |
51+
| Products Searched | A user has searched for products (with search `query`) |
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 \* |
54+
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.
5756
5857
## Cloud-mode Events
5958

@@ -118,7 +117,7 @@ All events (device-mode and cloud-mode) contain the Google Analytics `clientId`
118117

119118
## Support for email marketing destinations
120119

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

123122
## Alias Calls
124123

@@ -158,11 +157,12 @@ The list below outlines the properties included in the events listed above.
158157
| `presentment_currency` | The user's local currency | String |
159158
| `presentment_total` | The order total in local currency | String |
160159
| `products` | A list of all the product at that step of the funnel \* | Array |
160+
| `revenue` | Product revenue (excluding discounts, shipping and tax) | Float |
161161
| `sent_from` | A unique property to identify events sent by Littledata | String |
162162
| `shipping_method` | The shipping method chosen for checkout | String |
163163
| `shipping` | The shipping cost | Float |
164164
| `step` | The checkout step | Integer |
165-
| `subtotal` | The total less tax and shipping | Float |
165+
| `subtotal` | Order total after discounts but before taxes and shipping | Float |
166166
| `tax` | The amount of tax on the order | Float |
167167
| `total` | The total value of the order | Float |
168168
| `userId` | Chosen user identifier, defaulting to Shopify Customer ID | Double |
@@ -173,21 +173,23 @@ The list below outlines the properties included in the events listed above.
173173

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

176-
| Property | Description | Property Type |
177-
| -------------------- | ----------------------------------------------- | ------------- |
178-
| `brand` | The brand of the product | String |
179-
| `category` | The category of the product (defaults to `all`) | String |
180-
| `list_id` | The ID of the product collection | String |
181-
| `list_name` | The name of the product collection | String |
182-
| `list_position` | The product position in the collection | Integer |
183-
| `name` | The product name | String |
184-
| `price` | The product price | Float |
185-
| `product_id` | Shopify product ID | String |
186-
| `quantity` | The quantity of products | Integer |
187-
| `shopify_product_id` | Also Shopify product ID | String |
188-
| `shopify_variant_id` | The Shopify variant ID | String |
189-
| `sku` | The product SKU | String |
190-
| `variant` | The product variant name | String |
176+
| Property | Description | Property Type |
177+
| -------------------- | ------------------------------------------------------------------ | ------------- |
178+
| `brand` | The brand of the product (Shopify `vendor`) | String |
179+
| `category` | The category of the product (defaults to `all`) | String |
180+
| `compare_at_price` | The product price before any discount | String |
181+
| `image_url` | The URL of the first product image | String |
182+
| `list_id` | The ID of the product collection (for List Views and Clicks) | String |
183+
| `list_position` | The product position in the collection (for List Views and Clicks) | Integer |
184+
| `name` | The product name | String |
185+
| `price` | The product price | Float |
186+
| `product_id` | Shopify product ID | String |
187+
| `quantity` | The quantity of products | Integer |
188+
| `shopify_product_id` | Also Shopify product ID | String |
189+
| `shopify_variant_id` | The Shopify variant ID | String |
190+
| `sku` | The product SKU | String |
191+
| `url` | The URL of the product page | String |
192+
| `variant` | The product variant name | String |
191193

192194
## Advanced device-mode settings
193195

0 commit comments

Comments
 (0)