Skip to content

Commit bd78b68

Browse files
author
Prashant Singh
committed
Add new CX Studio source docs
1 parent 73c9342 commit bd78b68

File tree

1 file changed

+161
-0
lines changed
  • src/connections/sources/catalog/cloud-apps/cx-studio

1 file changed

+161
-0
lines changed

‎src/connections/sources/catalog/cloud-apps/cx-studio/index.md‎

Lines changed: 161 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,161 @@
1+
---
2+
title: CX Studio Source
3+
---
4+
5+
[Elastic Path CX Studio](https://www.elasticpath.com/products/cx-studio?utm_source=segmentio&utm_medium=docs&utm_campaign=partners){:target="_blank"} enables you to rapidly launch turn-key storefronts and shoppable landing pages that drive conversion and revenue, without reliance on IT.
6+
7+
This is an [Event Cloud Source](/docs/sources/#event-cloud-sources){:target="_blank"} which can not only export data into your Segment warehouse, but can also federate the exported data into your other enabled Segment Destinations.
8+
9+
This source is maintained by Elastic Path. For any issues with the source, contact the [Elastic Path Support team](https://support.elasticpath.com/hc/en-us){:target="_blank"}.
10+
11+
> info ""
12+
> The CX Studio Source is currently in beta, which means that they are still actively developing the source. If you are interested in joining their beta program or have any feedback to help improve the CX Studio Source and its documentation, [let the Elastic Path team know](https://support.elasticpath.com/hc/en-us).
13+
14+
## Getting started
15+
16+
1. Navigate to **Connections > Catalog** and make sure you're on the **Sources** tab of the catalog.
17+
2. Search for **CX Studio** in the Sources Catalog, select **CX Studio**, and click **Add Source**.
18+
3. Give the Source a name and configure any other settings.
19+
- The name identifies this source within your workspace, and typically reflects the name of the application. The name can be anything, but Segment recommends that you use something that reflects the source itself and distinguishes amongst your environments (for example, `SourceName_Prod`, `SourceName_Staging`, or `SourceName_Dev`).
20+
4. Click **Add Source** to save your settings.
21+
5. Copy the Write key from the Segment UI and [log in to the CX Studio](https://app.unstack.com/login).
22+
6. Navigate to Settings > Integrations > Select Segment integration, where you need to use Segment key.
23+
24+
## Stream
25+
26+
CX Studio uses our stream Source component to send Segment event data. It uses a client-side (select from `track`, `identify`, `page`, `group`) method(s) to send data to Segment. These events are then available in any destination that accepts client-side events, and available in a schema in your data warehouse, so you can query using SQL.
27+
28+
The default behavior is for CX Studio to pass the `anonymousId` if user is not logged in or pass `userId` if user is logged in. `anonymousId` is nothing but session id generated by CX Studio.
29+
30+
## Events
31+
32+
The table below lists events that CX Studio sends to Segment. These events appear as tables in your warehouse, and as regular events in other Destinations.
33+
34+
| Event Name | Description |
35+
| -------------------------------- | ---------------------------------------------------------------------- |
36+
| `Products Searched` | User searched for products. |
37+
| `Product List Viewed` | User viewed a product list or category |
38+
| `Product List Filtered` | User filtered a product list or category. |
39+
| `Product Viewed` | User viewed a product details. |
40+
| `Product Added` | User added a product to their shopping cart. |
41+
| `Product Removed` | User removed a product from their shopping cart. |
42+
| `Checkout Started` | User initiated the order process (a transaction is created). |
43+
| `Checkout Step Viewed` | User viewed a checkout step. |
44+
| `Checkout Step Completed` | User completed a checkout step. |
45+
46+
## Event properties
47+
48+
The property name tables below of the different events list the properties included in the events listed above.
49+
50+
### Browsing events
51+
52+
#### Products Searched
53+
54+
| Property Name | Description |
55+
| ------------------------- | -----------------------------------------------------------------------------------|
56+
| `query` | Query the user searched with e.g. shirt, jeans etc. |
57+
58+
#### Product List Viewed
59+
60+
| Property Name | Description |
61+
| ------------------------- | -----------------------------------------------------------------------------------|
62+
| `category` | Product category being viewed. |
63+
| `list_id` | Product list being viewed e.g. search. |
64+
| `products` | Products displayed in the product list. |
65+
| `products.$.brand` | Brand associated with the product. |
66+
| `products.$.currency` | Currency in which product price is shown to customer. |
67+
| `products.$.image_url` | Image url of the product. |
68+
| `products.$.name` | Name of the product being viewed. |
69+
| `products.$.price` | Price of the product being viewed. |
70+
| `products.$.product_id` | Product ID. |
71+
| `products.$.quantity` | Quantity of a product. |
72+
73+
#### Product List Filtered
74+
75+
| Property Name | Description |
76+
| ------------------------- | -----------------------------------------------------------------------------------|
77+
| `category` | Product category being viewed. |
78+
| `list_id` | Product list being viewed e.g. search. |
79+
| `products` | Products displayed in the product list. |
80+
| `products.$.brand` | Brand associated with the product. |
81+
| `products.$.currency` | Currency in which product price is shown to customer. |
82+
| `products.$.image_url` | Image url of the product. |
83+
| `products.$.name` | Name of the product being viewed. |
84+
| `products.$.price` | Price of the product being viewed. |
85+
| `products.$.product_id` | Product ID. |
86+
| `products.$.quantity` | Quantity of a product. |
87+
88+
### Core Ordering events
89+
90+
#### Product Viewed
91+
92+
| Property Name | Description |
93+
| ------------------------- | -----------------------------------------------------------------------------------|
94+
| `brand` | Brand associated with the product. |
95+
| `currency` | Currency in which product price is shown to customer. |
96+
| `image_url` | Image url of the product. |
97+
| `name` | Name of the product being viewed. |
98+
| `price` | Price of the product being viewed. |
99+
| `product_id` | Product ID. |
100+
| `quantity` | Quantity of a product. |
101+
102+
#### Product Added
103+
104+
| Property Name | Description |
105+
| ------------------------- | -----------------------------------------------------------------------------------|
106+
| `brand` | Brand associated with the product. |
107+
| `currency` | Currency in which product price is shown to customer. |
108+
| `image_url` | Image url of the product. |
109+
| `name` | Name of the product being viewed. |
110+
| `price` | Price of the product being viewed. |
111+
| `product_id` | Product ID. |
112+
| `quantity` | Quantity of a product. |
113+
114+
#### Product Removed
115+
116+
| Property Name | Description |
117+
| ------------------------- | -----------------------------------------------------------------------------------|
118+
| `brand` | Brand associated with the product. |
119+
| `currency` | Currency in which product price is shown to customer. |
120+
| `image_url` | Image url of the product. |
121+
| `name` | Name of the product being viewed. |
122+
| `price` | Price of the product being viewed. |
123+
| `product_id` | Product ID. |
124+
| `quantity` | Quantity of a product. |
125+
126+
#### Checkout Started
127+
128+
| Property Name | Description |
129+
| ------------------------- | -----------------------------------------------------------------------------------|
130+
| `currency` | Currency code associated with the transaction |
131+
| `discount` | Total discount associated with the transaction |
132+
| `order_id` | Currency in which product price is shown to customer. |
133+
| `shipping` | Shipping cost associated with the transaction. |
134+
| `tax` | Total tax associated with the transaction. |
135+
| `value` | Revenue ($) with discounts and coupons added in. |
136+
| `products` | Products displayed in the product list. |
137+
| `products.$.name` | Name of the product being viewed. |
138+
| `products.$.price` | Price of the product being viewed. |
139+
| `products.$.product_id` | Product ID. |
140+
| `products.$.quantity` | Quantity of a product. |
141+
| `products.$.sku` | Sku of the product being viewed |
142+
143+
#### Checkout Step Viewed
144+
145+
| Property Name | Description |
146+
| ------------------------- | -----------------------------------------------------------------------------------|
147+
| `checkout_id` | Checkout transaction ID |
148+
| `checkout_step` | Number representing a step in the checkout process |
149+
150+
#### Checkout Step Completed
151+
152+
| Property Name | Description |
153+
| ------------------------- | -----------------------------------------------------------------------------------|
154+
| `checkout_id` | Checkout transaction ID |
155+
| `checkout_step` | Number representing a step in the checkout process |
156+
157+
Note: CX Studio uses properties of these events from the [eCommerce Spec](/docs/connections/spec/ecommerce/v2){:target="_blank"} defined by the Segment doc.
158+
159+
## Add destinations
160+
161+
After you configure your source, you can connect it with destinations. Log in to your downstream tools and check to see that your events appear as expected, and that they contain all of the properties you expect. If your events and properties don’t appear, check the Event Delivery tool, and refer to the destination docs for each tool for troubleshooting. If there are any issues with how the events arrive to Segment, contact the [Elastic Path Support team](https://support.elasticpath.com/hc/en-us){:target="_blank"}.

0 commit comments

Comments
 (0)