Click

Events categorized under the click level are utilized to monitor and analyze user interactions within the storefront. For instance, tracking when a user adds a product to the cart or initiates a login process.

Add to cart

This event is generated to track add to cart actions, indicating when a user has added an item to their shopping cart. It provides comprehensive details about the user, the product added, and the context in which the addition occurred. Context here implies details about the version of the library sending the event and the device information like os, screen size, timezone etc.

Events

click/add_to_cart/engagement/v1

# This event is triggered when a user adds an item to their shopping cart. It includes detailed information about the user, the product added and details about the version of the library and the device information like os, screen size, timezone etc.

Add To Cart/add_to_cart/engagement/v1

This event is triggered when a user adds an item to their shopping cart. It includes detailed information about the user, the product added and details about the version of the library and the device information like os, screen size, timezone etc.

Payload

Properties

Event emitted when a user adds an item to their shopping cart.

context

object

Required

Context information related to the environment where the event occurred. This includes details about the library generating the event, the operating system, user timezone, screen resolution, user agent, locale, and device specifications.

Properties

library

object

Required

Library information which is sending the event.

Properties

name

string

Required

Name of the library sending the event.

version

string

Required

Version of the library.

object

Required

Operating system details for the user device.

Properties

name

string

Required

OS name.

version

string

Required

OS version.

timezone

string

Required

User's timezone.

screen

object

Required

Screen resolution details.

Properties

width

integer

Required

Screen width in pixels.

height

integer

Required

Screen height in pixels.

user_agent

string

Required

User agent information.

locale

string

Required

User's locale information.

device

object

Required

User's device details.

Properties

is_mobile

boolean

Required

Indicates if the device is mobile or not.

event_id

string

Required

Unique identifier for the add to cart event.

event_name

string

Required

Name of the event, typically "add_to_cart".

article_id

string

Required

Unique identifier for the article associated with the product.

brand

string

Required

Brand name of the product added to the cart.

cart_id

string

Required

Unique identifier for the shopping cart.

version

string

Required

Version of the event schema.

company_created_on

string

| date-time

Required

Timestamp or detailed information indicating when the company was created. Can be an ISO 8601 string or a complex object with additional details.

company_id

integer

Required

Unique identifier for the company associated with the event.

company_mode

string

Required

Mode of the company (e.g., "live", "development").

Enum

currency

string

Required

Currency code (e.g., "USD", "INR") used for the product price.

event_type

string

Required

Type of the event (e.g., "engagement").

Enum

l1_category

string

Required

Primary category of the product (Level 1).

l3_category

string

Required

Tertiary category of the product (Level 3).

position

string|null

Required

Position of the product in the listing when it was clicked on. Use `null` if not applicable.

price

number

Required

Price of the product in the specified currency.

product_id

integer

Required

Unique identifier for the product being added to the cart.

quantity

integer

Required

Number of units of the product added to the cart.

query

string|null

Required

Search query entered by the user, if applicable. Use `null` if not applicable.

search_id

string|null

Required

Identifier for the search journey, if applicable. Use `null` if not applicable.

source_url

string

Required

URL from which the product was added to the cart.

utm_campaign

string

Specific marketing campaign associated with the product addition.

utm_medium

string

Marketing medium through which the user arrived at the product.

utm_source

string

Marketing source driving the traffic to the product.

event_timestamp

string

| date-time

Required

ISO 8601 timestamp indicating when the event occurred.

user_id

string|null

Identifier of the user performing the add to cart action. Use `null` if the user is anonymous.

anonymous_id

string

Required

Anonymous identifier assigned to the user if they are not logged in.

Payload Schema JSON

1{
2  "type": "object",
3  "required": [
4    "context",
5    "event_id",
6    "event_name",
7    "event_timestamp",
8    "anonymous_id",
9    "article_id",
10    "brand",
11    "cart_id",
12    "company_created_on",
13    "company_id",
14    "company_mode",
15    "currency",
16    "event_type",
17    "l1_category",
18    "l3_category",
19    "position",
20    "price",
21    "product_id",
22    "quantity",
23    "query",
24    "search_id",
25    "source_url",
26    "version"
27  ],
28  "description": "Event emitted when a user adds an item to their shopping cart.",
29  "properties": {
30    "context": {
31      "type": "object",
32      "description": "Context information related to the environment where the event occurred. This includes details about the library generating the event, the operating system, user timezone, screen resolution, user agent, locale, and device specifications.",
33      "properties": {
34        "library": {
35          "type": "object",
36          "description": "Library information which is sending the event.",
37          "properties": {
38            "name": {
39              "type": "string",
40              "description": "Name of the library sending the event.",
41              "example": "flick"
42            },
43            "version": {
44              "type": "string",
45              "description": "Version of the library.",
46              "example": "1.1.1"
47            }
48          },
49          "required": [
50            "name",
51            "version"
52          ]
53        },
54        "os": {
55          "type": "object",
56          "description": "Operating system details for the user device.",
57          "properties": {
58            "name": {
59              "type": "string",
60              "description": "OS name.",
61              "example": "Mac OS"
62            },
63            "version": {
64              "type": "string",
65              "description": "OS version.",
66              "example": "10.15.7"
67            }
68          },
69          "required": [
70            "name",
71            "version"
72          ]
73        },
74        "timezone": {
75          "type": "string",
76          "description": "User's timezone.",
77          "example": "Asia/Calcutta"
78        },
79        "screen": {
80          "type": "object",
81          "description": "Screen resolution details.",
82          "properties": {
83            "width": {
84              "type": "integer",
85              "description": "Screen width in pixels.",
86              "example": 1512
87            },
88            "height": {
89              "type": "integer",
90              "description": "Screen height in pixels.",
91              "example": 859
92            }
93          },
94          "required": [
95            "width",
96            "height"
97          ]
98        },
99        "user_agent": {
100          "type": "string",
101          "description": "User agent information.",
102          "example": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/122.0.0.0 Safari/537.36"
103        },
104        "locale": {
105          "type": "string",
106          "description": "User's locale information.",
107          "example": "en-GB"
108        },
109        "device": {
110          "type": "object",
111          "description": "User's device details.",
112          "properties": {
113            "is_mobile": {
114              "type": "boolean",
115              "description": "Indicates if the device is mobile or not.",
116              "example": false
117            }
118          },
119          "required": [
120            "is_mobile"
121          ]
122        }
123      },
124      "required": [
125        "library",
126        "os",
127        "timezone",
128        "screen",
129        "user_agent",
130        "locale",
131        "device"
132      ]
133    },
134    "event_id": {
135      "type": "string",
136      "description": "Unique identifier for the add to cart event."
137    },
138    "event_name": {
139      "type": "string",
140      "description": "Name of the event, typically \"add_to_cart\"."
141    },
142    "article_id": {
143      "type": "string",
144      "description": "Unique identifier for the article associated with the product."
145    },
146    "brand": {
147      "type": "string",
148      "description": "Brand name of the product added to the cart."
149    },
150    "cart_id": {
151      "type": "string",
152      "description": "Unique identifier for the shopping cart."
153    },
154    "version": {
155      "type": "string",
156      "description": "Version of the event schema."
157    },
158    "company_created_on": {
159      "type": "string",
160      "format": "date-time",
161      "description": "Timestamp or detailed information indicating when the company was created.\nCan be an ISO 8601 string or a complex object with additional details.\n"
162    },
163    "company_id": {
164      "type": "integer",
165      "description": "Unique identifier for the company associated with the event."
166    },
167    "company_mode": {
168      "type": "string",
169      "description": "Mode of the company (e.g., \"live\", \"development\").",
170      "enum": [
171        "live",
172        "development"
173      ]
174    },
175    "currency": {
176      "type": "string",
177      "description": "Currency code (e.g., \"USD\", \"INR\") used for the product price."
178    },
179    "event_type": {
180      "type": "string",
181      "description": "Type of the event (e.g., \"engagement\").",
182      "enum": [
183        "engagement",
184        "click",
185        "conversion",
186        "impression",
187        "search",
188        "identity"
189      ]
190    },
191    "l1_category": {
192      "type": "string",
193      "x-not-enum": true,
194      "description": "Primary category of the product (Level 1)."
195    },
196    "l3_category": {
197      "type": "string",
198      "x-not-enum": true,
199      "description": "Tertiary category of the product (Level 3)."
200    },
201    "position": {
202      "type": [
203        "string",
204        "null"
205      ],
206      "description": "Position of the product in the listing when it was clicked on. Use `null` if not applicable."
207    },
208    "price": {
209      "type": "number",
210      "description": "Price of the product in the specified currency."
211    },
212    "product_id": {
213      "type": "integer",
214      "description": "Unique identifier for the product being added to the cart."
215    },
216    "quantity": {
217      "type": "integer",
218      "description": "Number of units of the product added to the cart."
219    },
220    "query": {
221      "type": [
222        "string",
223        "null"
224      ],
225      "description": "Search query entered by the user, if applicable. Use `null` if not applicable."
226    },
227    "search_id": {
228      "type": [
229        "string",
230        "null"
231      ],
232      "description": "Identifier for the search journey, if applicable. Use `null` if not applicable."
233    },
234    "source_url": {
235      "type": "string",
236      "description": "URL from which the product was added to the cart."
237    },
238    "utm_campaign": {
239      "type": "string",
240      "description": "Specific marketing campaign associated with the product addition."
241    },
242    "utm_medium": {
243      "type": "string",
244      "description": "Marketing medium through which the user arrived at the product."
245    },
246    "utm_source": {
247      "type": "string",
248      "description": "Marketing source driving the traffic to the product."
249    },
250    "event_timestamp": {
251      "type": "string",
252      "format": "date-time",
253      "description": "ISO 8601 timestamp indicating when the event occurred."
254    },
255    "user_id": {
256      "type": [
257        "string",
258        "null"
259      ],
260      "description": "Identifier of the user performing the add to cart action. Use `null` if the user is anonymous."
261    },
262    "anonymous_id": {
263      "type": "string",
264      "description": "Anonymous identifier assigned to the user if they are not logged in."
265    }
266  }
267}

Payload Example

1{
2  "context": {
3    "library": {
4      "name": "flick",
5      "version": "1.0.4"
6    },
7    "os": {
8      "name": "Mac OS",
9      "version": "10.15.7"
10    },
11    "timezone": "Asia/Calcutta",
12    "screen": {
13      "width": 1512,
14      "height": 859
15    },
16    "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/122.0.0.0 Safari/537.36",
17    "locale": "en-GB",
18    "device": {
19      "is_mobile": false
20    }
21  },
22  "event_id": "evt_1234567890",
23  "event_name": "add_to_cart",
24  "version": "1",
25  "event_timestamp": "2025-01-31T12:34:56Z",
26  "user_id": "user_12345",
27  "anonymous_id": "791392dc-e279-43f9-914c-e8a42a9ee421",
28  "article_id": "art_9876543210",
29  "brand": "Armani Exchange",
30  "cart_id": "cart_67890",
31  "company_created_on": "2020-05-20T08:30:00Z",
32  "company_id": 123456,
33  "company_mode": "live",
34  "currency": "INR",
35  "event_type": "engagement",
36  "l1_category": "Clothing",
37  "l3_category": "Sweatshirts",
38  "position": "top",
39  "price": 150.75,
40  "product_id": 7818334,
41  "quantity": 1,
42  "query": "allen solly",
43  "search_id": "search_67890",
44  "source_url": "https://www.example.com/product/7818334",
45  "utm_campaign": "similar_products",
46  "utm_medium": "product_recommendation",
47  "utm_source": "product_page"
48}

« extension-subscription/create/v1

delivery_promise/click/v1 »