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.
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.
Payload
Properties
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.
os
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": 151287 },88 "height": {89 "type": "integer",90 "description": "Screen height in pixels.",91 "example": 85992 }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": false117 }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": 85915 },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": false20 }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}
Was this section helpful?
This event is triggered when a pincode present in the URL is updated. This can be triggered from any page containing the pincode details in the URL. It provides comprehensive details about the user, the pincode added, and the context in which the event 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/delivery_promise/click/v1
# This event is triggered when a user performs a pincode servicability check. It includes detailed information about the user, the pincode added and details about the version of the library and the device information like os, screen size, timezone etc.
Payload
Properties
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.
os
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.
query
string|null
Search query entered by the user, if applicable. Use `null` if not applicable.
user_id
string|null
Identifier of the user performing the delivery_promise action. Use `null` if the user is anonymous.
version
string
Required
Version of the event schema.
currency
string
Required
Currency associated with the country pincode being checked.
event_id
string
Required
Unique identifier for the event.
country_iso_code
string
Required
ISO2 code for the country associated with pincode being checked.
city
string
Required
City associated with pincode being checked.
country
string
Required
Country associated with pincode being checked.
pincode
string
Required
Pincode being validated by the user.
sector
string|null
Sector associated with pincode being checked.
position
string|null
Position of the product in the listing when it was clicked on. Use `null` if not applicable.
search_id
string|null
Identifier for the search journey, if applicable. Use `null` if not applicable.
company_id
integer
Unique identifier for the company associated with the event.
event_name
string
Required
Name of the event, typically "delivery_promise".
event_type
string
Required
Type of the event (e.g., "click").
Enum
anonymous_id
string
Required
Anonymous identifier for the user.
company_mode
string
Mode of the company (e.g., "live", "development").
Enum
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
Timestamp of the event.
company_created_on
string
| date-time
Timestamp or detailed information indicating when the company was created.
Can be an ISO 8601 string or a complex object with additional details.
Payload Schema JSON
1{2 "type": "object",3 "required": [4 "context",5 "anonymous_id",6 "pincode",7 "country",8 "currency",9 "version",10 "event_id",11 "country_iso_code",12 "city",13 "event_name",14 "event_type"15 ],16 "description": "Event emitted when a user checks any pincode for servicability.",17 "properties": {18 "context": {19 "type": "object",20 "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.",21 "properties": {22 "library": {23 "type": "object",24 "description": "Library information which is sending the event.",25 "properties": {26 "name": {27 "type": "string",28 "description": "Name of the library sending the event.",29 "example": "flick"30 },31 "version": {32 "type": "string",33 "description": "Version of the library.",34 "example": "1.1.1"35 }36 },37 "required": [38 "name",39 "version"40 ]41 },42 "os": {43 "type": "object",44 "description": "Operating system details for the user device.",45 "properties": {46 "name": {47 "type": "string",48 "description": "OS name.",49 "example": "Mac OS"50 },51 "version": {52 "type": "string",53 "description": "OS version.",54 "example": "10.15.7"55 }56 },57 "required": [58 "name",59 "version"60 ]61 },62 "timezone": {63 "type": "string",64 "description": "User's timezone.",65 "example": "Asia/Calcutta"66 },67 "screen": {68 "type": "object",69 "description": "Screen resolution details.",70 "properties": {71 "width": {72 "type": "integer",73 "description": "Screen width in pixels.",74 "example": 151275 },76 "height": {77 "type": "integer",78 "description": "Screen height in pixels.",79 "example": 85980 }81 },82 "required": [83 "width",84 "height"85 ]86 },87 "user_agent": {88 "type": "string",89 "description": "User agent information.",90 "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"91 },92 "locale": {93 "type": "string",94 "description": "User's locale information.",95 "example": "en-GB"96 },97 "device": {98 "type": "object",99 "description": "User's device details.",100 "properties": {101 "is_mobile": {102 "type": "boolean",103 "description": "Indicates if the device is mobile or not.",104 "example": false105 }106 },107 "required": [108 "is_mobile"109 ]110 }111 },112 "required": [113 "library",114 "os",115 "timezone",116 "screen",117 "user_agent",118 "locale",119 "device"120 ]121 },122 "query": {123 "type": [124 "string",125 "null"126 ],127 "description": "Search query entered by the user, if applicable. Use `null` if not applicable."128 },129 "user_id": {130 "type": [131 "string",132 "null"133 ],134 "description": "Identifier of the user performing the delivery_promise action. Use `null` if the user is anonymous."135 },136 "version": {137 "type": "string",138 "description": "Version of the event schema."139 },140 "currency": {141 "type": "string",142 "description": "Currency associated with the country pincode being checked."143 },144 "event_id": {145 "type": "string",146 "description": "Unique identifier for the event."147 },148 "country_iso_code": {149 "type": "string",150 "description": "ISO2 code for the country associated with pincode being checked.",151 "x-not-enum": true152 },153 "city": {154 "type": "string",155 "description": "City associated with pincode being checked."156 },157 "country": {158 "type": "string",159 "description": "Country associated with pincode being checked."160 },161 "pincode": {162 "type": "string",163 "description": "Pincode being validated by the user."164 },165 "sector": {166 "type": [167 "string",168 "null"169 ],170 "description": "Sector associated with pincode being checked."171 },172 "position": {173 "type": [174 "string",175 "null"176 ],177 "description": "Position of the product in the listing when it was clicked on. Use `null` if not applicable."178 },179 "search_id": {180 "type": [181 "string",182 "null"183 ],184 "description": "Identifier for the search journey, if applicable. Use `null` if not applicable."185 },186 "company_id": {187 "type": "integer",188 "description": "Unique identifier for the company associated with the event."189 },190 "event_name": {191 "type": "string",192 "description": "Name of the event, typically \"delivery_promise\"."193 },194 "event_type": {195 "type": "string",196 "description": "Type of the event (e.g., \"click\").",197 "enum": [198 "engagement",199 "click",200 "conversion",201 "impression",202 "search",203 "identity"204 ]205 },206 "anonymous_id": {207 "type": "string",208 "description": "Anonymous identifier for the user."209 },210 "company_mode": {211 "type": "string",212 "description": "Mode of the company (e.g., \"live\", \"development\").",213 "enum": [214 "live",215 "development"216 ]217 },218 "utm_campaign": {219 "type": "string",220 "description": "Specific marketing campaign associated with the product addition."221 },222 "utm_medium": {223 "type": "string",224 "description": "Marketing medium through which the user arrived at the product."225 },226 "utm_source": {227 "type": "string",228 "description": "Marketing source driving the traffic to the product."229 },230 "event_timestamp": {231 "type": "string",232 "format": "date-time",233 "description": "Timestamp of the event."234 },235 "company_created_on": {236 "type": "string",237 "format": "date-time",238 "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"239 }240 }241}
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": 85915 },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": false20 }21 },22 "event_id": "evt_1234567890",23 "event_name": "delivery_promise",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 "company_created_on": "2020-05-20T08:30:00Z",29 "company_id": 123456,30 "company_mode": "live",31 "currency": "INR",32 "event_type": "click",33 "city": "Mumbai",34 "country": "India",35 "country_iso_code": "IN",36 "sector": null,37 "pincode": 400068,38 "position": "2",39 "query": "allen solly",40 "search_id": "search_67890",41 "utm_campaign": "similar_products",42 "utm_medium": "product_recommendation",43 "utm_source": "product_page"44}
Was this section helpful?
This event is triggered when a user performs a pincode servicability check on the product page for React themes. It is a part of 3 events triggered simultaneously with delivery_promise and product_price. This event contains the location details of the pincode. It provides comprehensive details about the user, the pincode added, and the context in which the event 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/location_details/click/v1
# This event is triggered when a user performs a pincode servicability check. It includes detailed information about the user, the pincode added and details about the version of the library and the device information like os, screen size, timezone etc.
Payload
Properties
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.
os
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.
query
string|null
Search query entered by the user, if applicable. Use `null` if not applicable.
user_id
string|null
Identifier of the user performing the location details action. Use `null` if the user is anonymous.
version
string
Required
Version of the event schema.
currency
string
Required
Currency associated with the country pincode being checked.
event_id
string
Required
Unique identifier for the event.
country_iso_code
string
Required
ISO2 code for the country associated with pincode being checked.
city
string
Required
City associated with pincode being checked.
country
string
Required
Country associated with pincode being checked.
pincode
string
Required
Pincode being validated by the user.
sector
string|null
Sector associated with pincode being checked.
position
string|null
Position of the product in the listing when it was clicked on. Use `null` if not applicable.
search_id
string|null
Identifier for the search journey, if applicable. Use `null` if not applicable.
company_id
integer
Unique identifier for the company associated with the event.
event_name
string
Required
Name of the event, typically "location_details".
event_type
string
Required
Type of the event (e.g., "click").
Enum
anonymous_id
string
Required
Anonymous identifier for the user.
company_mode
string
Mode of the company (e.g., "live", "development").
Enum
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
Timestamp of the event.
company_created_on
string
| date-time
Timestamp or detailed information indicating when the company was created.
Can be an ISO 8601 string or a complex object with additional details.
Payload Schema JSON
1{2 "type": "object",3 "required": [4 "context",5 "anonymous_id",6 "pincode",7 "country",8 "currency",9 "version",10 "event_id",11 "country_iso_code",12 "city",13 "event_name",14 "event_type"15 ],16 "description": "Event emitted when a user checks any pincode for servicability.",17 "properties": {18 "context": {19 "type": "object",20 "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.",21 "properties": {22 "library": {23 "type": "object",24 "description": "Library information which is sending the event.",25 "properties": {26 "name": {27 "type": "string",28 "description": "Name of the library sending the event.",29 "example": "flick"30 },31 "version": {32 "type": "string",33 "description": "Version of the library.",34 "example": "1.1.1"35 }36 },37 "required": [38 "name",39 "version"40 ]41 },42 "os": {43 "type": "object",44 "description": "Operating system details for the user device.",45 "properties": {46 "name": {47 "type": "string",48 "description": "OS name.",49 "example": "Mac OS"50 },51 "version": {52 "type": "string",53 "description": "OS version.",54 "example": "10.15.7"55 }56 },57 "required": [58 "name",59 "version"60 ]61 },62 "timezone": {63 "type": "string",64 "description": "User's timezone.",65 "example": "Asia/Calcutta"66 },67 "screen": {68 "type": "object",69 "description": "Screen resolution details.",70 "properties": {71 "width": {72 "type": "integer",73 "description": "Screen width in pixels.",74 "example": 151275 },76 "height": {77 "type": "integer",78 "description": "Screen height in pixels.",79 "example": 85980 }81 },82 "required": [83 "width",84 "height"85 ]86 },87 "user_agent": {88 "type": "string",89 "description": "User agent information.",90 "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"91 },92 "locale": {93 "type": "string",94 "description": "User's locale information.",95 "example": "en-GB"96 },97 "device": {98 "type": "object",99 "description": "User's device details.",100 "properties": {101 "is_mobile": {102 "type": "boolean",103 "description": "Indicates if the device is mobile or not.",104 "example": false105 }106 },107 "required": [108 "is_mobile"109 ]110 }111 },112 "required": [113 "library",114 "os",115 "timezone",116 "screen",117 "user_agent",118 "locale",119 "device"120 ]121 },122 "query": {123 "type": [124 "string",125 "null"126 ],127 "description": "Search query entered by the user, if applicable. Use `null` if not applicable."128 },129 "user_id": {130 "type": [131 "string",132 "null"133 ],134 "description": "Identifier of the user performing the location details action. Use `null` if the user is anonymous."135 },136 "version": {137 "type": "string",138 "description": "Version of the event schema."139 },140 "currency": {141 "type": "string",142 "description": "Currency associated with the country pincode being checked."143 },144 "event_id": {145 "type": "string",146 "description": "Unique identifier for the event."147 },148 "country_iso_code": {149 "type": "string",150 "description": "ISO2 code for the country associated with pincode being checked.",151 "x-not-enum": true152 },153 "city": {154 "type": "string",155 "description": "City associated with pincode being checked."156 },157 "country": {158 "type": "string",159 "description": "Country associated with pincode being checked."160 },161 "pincode": {162 "type": "string",163 "description": "Pincode being validated by the user."164 },165 "sector": {166 "type": [167 "string",168 "null"169 ],170 "description": "Sector associated with pincode being checked."171 },172 "position": {173 "type": [174 "string",175 "null"176 ],177 "description": "Position of the product in the listing when it was clicked on. Use `null` if not applicable."178 },179 "search_id": {180 "type": [181 "string",182 "null"183 ],184 "description": "Identifier for the search journey, if applicable. Use `null` if not applicable."185 },186 "company_id": {187 "type": "integer",188 "description": "Unique identifier for the company associated with the event."189 },190 "event_name": {191 "type": "string",192 "description": "Name of the event, typically \"location_details\"."193 },194 "event_type": {195 "type": "string",196 "description": "Type of the event (e.g., \"click\").",197 "enum": [198 "engagement",199 "click",200 "conversion",201 "impression",202 "search",203 "identity"204 ]205 },206 "anonymous_id": {207 "type": "string",208 "description": "Anonymous identifier for the user."209 },210 "company_mode": {211 "type": "string",212 "description": "Mode of the company (e.g., \"live\", \"development\").",213 "enum": [214 "live",215 "development"216 ]217 },218 "utm_campaign": {219 "type": "string",220 "description": "Specific marketing campaign associated with the product addition."221 },222 "utm_medium": {223 "type": "string",224 "description": "Marketing medium through which the user arrived at the product."225 },226 "utm_source": {227 "type": "string",228 "description": "Marketing source driving the traffic to the product."229 },230 "event_timestamp": {231 "type": "string",232 "format": "date-time",233 "description": "Timestamp of the event."234 },235 "company_created_on": {236 "type": "string",237 "format": "date-time",238 "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"239 }240 }241}
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": 85915 },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": false20 }21 },22 "event_id": "evt_1234567890",23 "event_name": "location_details",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 "company_created_on": "2020-05-20T08:30:00Z",29 "company_id": 123456,30 "company_mode": "live",31 "currency": "INR",32 "event_type": "click",33 "city": "Mumbai",34 "country": "India",35 "country_iso_code": "IN",36 "sector": null,37 "pincode": 400068,38 "position": "2",39 "query": "allen solly",40 "search_id": "search_67890",41 "utm_campaign": "similar_products",42 "utm_medium": "product_recommendation",43 "utm_source": "product_page"44}
Was this section helpful?
This event is generated to track orders checked out by the user, this is emitted after user has checked out the order. It provides essential information about the order and the cart being checked out. In contrast to order checkout which is emitted at checkout page, this event is triggered when user leaves the checkout screen after successfully checking out the order.
Events
click/order_checkedout/conversion/v1
# This event is emitted after the user has checked out the order.
Payload
Properties
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.
os
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 event.
event_name
string
Required
Name of the event, typically "order_checkedout".
version
string
Required
Version of the event schema.
event_type
string
Required
Type of the event (e.g., "engagement").
Enum
cart_id
string
Required
Unique identifier for the shopping cart.
cart_total
number
Required
Total amount in the shopping cart before shipping and taxes.
shipping
number
Required
Shipping charges applied to the order.
order_id
string
Required
Unique identifier for the order.
tax
number
Required
Total tax applied to the order.
order_total
number
Required
Total amount of the order after shipping and taxes.
products
array of object
Required
List of products included in the order.
Array of Properties
product_id
integer
Required
Product ID.
l3_category
string
Required
Tertiary category of the product.
l1_category
string
Required
Primary category of the product.
quantity
integer
Required
Quantity of the product purchased.
price
number
Required
Price per unit of the product.
value
number
Required
Total value for the products.
currency
string
Required
Currency code (e.g., "INR").
article_id
string
Required
Article identifier for the product.
company_mode
string
Required
Mode of the company (e.g., "live", "development").
Enum
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
Company identifier.
event_timestamp
string
| date-time
Required
Timestamp of the event.
user_id
string|null
Identifier of the user performing the order checkedout 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 "event_type",10 "cart_id",11 "cart_total",12 "shipping",13 "order_id",14 "tax",15 "order_total",16 "products",17 "company_mode",18 "company_created_on",19 "company_id",20 "version"21 ],22 "description": "Event emitted when a user completes the checkout process for an order on the storefront.",23 "properties": {24 "context": {25 "type": "object",26 "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.",27 "properties": {28 "library": {29 "type": "object",30 "description": "Library information which is sending the event.",31 "properties": {32 "name": {33 "type": "string",34 "description": "Name of the library sending the event.",35 "example": "flick"36 },37 "version": {38 "type": "string",39 "description": "Version of the library.",40 "example": "1.1.1"41 }42 },43 "required": [44 "name",45 "version"46 ]47 },48 "os": {49 "type": "object",50 "description": "Operating system details for the user device.",51 "properties": {52 "name": {53 "type": "string",54 "description": "OS name.",55 "example": "Mac OS"56 },57 "version": {58 "type": "string",59 "description": "OS version.",60 "example": "10.15.7"61 }62 },63 "required": [64 "name",65 "version"66 ]67 },68 "timezone": {69 "type": "string",70 "description": "User's timezone.",71 "example": "Asia/Calcutta"72 },73 "screen": {74 "type": "object",75 "description": "Screen resolution details.",76 "properties": {77 "width": {78 "type": "integer",79 "description": "Screen width in pixels.",80 "example": 151281 },82 "height": {83 "type": "integer",84 "description": "Screen height in pixels.",85 "example": 85986 }87 },88 "required": [89 "width",90 "height"91 ]92 },93 "user_agent": {94 "type": "string",95 "description": "User agent information.",96 "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"97 },98 "locale": {99 "type": "string",100 "description": "User's locale information.",101 "example": "en-GB"102 },103 "device": {104 "type": "object",105 "description": "User's device details.",106 "properties": {107 "is_mobile": {108 "type": "boolean",109 "description": "Indicates if the device is mobile or not.",110 "example": false111 }112 },113 "required": [114 "is_mobile"115 ]116 }117 },118 "required": [119 "library",120 "os",121 "timezone",122 "screen",123 "user_agent",124 "locale",125 "device"126 ]127 },128 "event_id": {129 "type": "string",130 "description": "Unique identifier for the event."131 },132 "event_name": {133 "type": "string",134 "description": "Name of the event, typically \"order_checkedout\"."135 },136 "version": {137 "type": "string",138 "description": "Version of the event schema."139 },140 "event_type": {141 "type": "string",142 "description": "Type of the event (e.g., \"engagement\").",143 "enum": [144 "engagement",145 "click",146 "conversion",147 "impression",148 "search",149 "identity"150 ]151 },152 "cart_id": {153 "type": "string",154 "description": "Unique identifier for the shopping cart."155 },156 "cart_total": {157 "type": "number",158 "description": "Total amount in the shopping cart before shipping and taxes."159 },160 "shipping": {161 "type": "number",162 "description": "Shipping charges applied to the order."163 },164 "order_id": {165 "type": "string",166 "description": "Unique identifier for the order."167 },168 "tax": {169 "type": "number",170 "description": "Total tax applied to the order."171 },172 "order_total": {173 "type": "number",174 "description": "Total amount of the order after shipping and taxes."175 },176 "products": {177 "type": "array",178 "description": "List of products included in the order.",179 "items": {180 "type": "object",181 "description": "Details of each product in the order.",182 "properties": {183 "product_id": {184 "type": "integer",185 "description": "Product ID."186 },187 "l3_category": {188 "type": "string",189 "x-not-enum": true,190 "description": "Tertiary category of the product."191 },192 "l1_category": {193 "type": "string",194 "x-not-enum": true,195 "description": "Primary category of the product."196 },197 "quantity": {198 "type": "integer",199 "description": "Quantity of the product purchased."200 },201 "price": {202 "type": "number",203 "description": "Price per unit of the product."204 },205 "value": {206 "type": "number",207 "description": "Total value for the products."208 },209 "currency": {210 "type": "string",211 "description": "Currency code (e.g., \"INR\")."212 },213 "article_id": {214 "type": "string",215 "description": "Article identifier for the product."216 }217 },218 "required": [219 "product_id",220 "l3_category",221 "l1_category",222 "quantity",223 "price",224 "value",225 "currency",226 "article_id"227 ]228 }229 },230 "company_mode": {231 "type": "string",232 "description": "Mode of the company (e.g., \"live\", \"development\").",233 "enum": [234 "live",235 "development"236 ]237 },238 "company_created_on": {239 "type": "string",240 "format": "date-time",241 "description": "Timestamp or detailed information indicating when the company was created. Can be an ISO 8601 string or a complex object with additional details."242 },243 "company_id": {244 "type": "integer",245 "description": "Company identifier."246 },247 "event_timestamp": {248 "type": "string",249 "format": "date-time",250 "description": "Timestamp of the event."251 },252 "user_id": {253 "type": [254 "string",255 "null"256 ],257 "description": "Identifier of the user performing the order checkedout action. Use `null` if the user is anonymous."258 },259 "anonymous_id": {260 "type": "string",261 "description": "Anonymous identifier assigned to the user if they are not logged in."262 }263 }264}
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": 85915 },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": false20 }21 },22 "event_id": "evt_1234567890",23 "event_name": "order_checkedout",24 "version": "1",25 "event_timestamp": "2025-01-31T12:34:56Z",26 "anonymous_id": "791392dc-e279-43f9-914c-e8a42a9ee421",27 "event_type": "engagement",28 "cart_id": "cart_9876543210",29 "cart_total": 250.75,30 "shipping": 15,31 "order_id": "order_1234567890",32 "tax": 20,33 "order_total": 285.75,34 "products": [35 {36 "product_id": 4001,37 "l3_category": "Electronics",38 "l1_category": "Home Appliances",39 "quantity": 1,40 "price": 200,41 "value": 200,42 "currency": "USD",43 "article_id": "A123"44 },45 {46 "product_id": 4002,47 "l3_category": "Accessories",48 "l1_category": "Mobile Accessories",49 "quantity": 2,50 "price": 25,51 "value": 50,52 "currency": "USD",53 "article_id": "A124"54 }55 ],56 "company_mode": "live",57 "company_created_on": "2020-05-20T08:30:00Z",58 "company_id": 1234,59 "user_id": "user_12345"60}
Was this section helpful?
This event is generated to track order checkout events, indicating when a user is checking out an order. It provides essential information about the order and its contents. This event is generated when a user visits the checkout page on the storefront.
Events
click/order_checkout/conversion/v1
# This event is emitted when a user proceeds to checkout an order
Payload
Properties
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.
os
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 order checkout event.
event_name
string
Required
Name of the event, typically "order_checkout".
event_type
string
Required
Type of the event (e.g., "engagement").
Enum
cart_id
string
Required
Unique identifier for the shopping cart associated with the order.
cart_total
number
Total amount of the cart before taxes and shipping.
shipping
number
Shipping cost associated with the order.
order_id
string
Unique identifier for the order.
tax
number
Tax amount applied to the order.
order_total
number
Total amount of the order including taxes and shipping.
products
array of object
List of products included in the order.
Array of Properties
product_id
integer
Required
Unique identifier for the product being ordered.
l3_category
string
Required
Tertiary category of the product.
l1_category
string
Required
Primary category of the product.
quantity
integer
Required
Number of units of the product in the order.
price
number
Required
Price per unit of the product.
value
number
Required
Total value for the product (price multiplied by quantity).
currency
string
Required
Currency code (e.g., "USD", "INR") used for the product price.
article_id
string
Required
Unique identifier for the article associated with the product.
company_mode
string
Required
Mode of the company (e.g., "live", "development").
Enum
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
string
Required
Unique identifier for the company associated with the event.
version
string
Required
Version of the event schema.
event_timestamp
string
| date-time
Required
ISO 8601 timestamp indicating when the event occurred.
user_id
string|null
Identifier of the user performing the order checkout action. Use `"null"` if the user is anonymous.
anonymous_id
string
Required
Anonymous identifier assigned to the user if they are not logged in.
utm_medium
string
Marketing medium through which the user arrived at the product (e.g., "email", "cpc").
utm_source
string
Marketing source driving the traffic to the product (e.g., "newsletter", "google").
utm_campaign
string
Specific marketing campaign associated with the product checkout.
source_url
string
Required
URL from which the product was added to the cart.
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 "price",20 "product_id",21 "quantity",22 "source_url",23 "value",24 "version"25 ],26 "description": "Event emitted when a user is checking out an order by visiting the checkout page on the storefront.",27 "properties": {28 "context": {29 "type": "object",30 "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.",31 "properties": {32 "library": {33 "type": "object",34 "description": "Library information which is sending the event.",35 "properties": {36 "name": {37 "type": "string",38 "description": "Name of the library sending the event.",39 "example": "flick"40 },41 "version": {42 "type": "string",43 "description": "Version of the library.",44 "example": "1.1.1"45 }46 },47 "required": [48 "name",49 "version"50 ]51 },52 "os": {53 "type": "object",54 "description": "Operating system details for the user device.",55 "properties": {56 "name": {57 "type": "string",58 "description": "OS name.",59 "example": "Mac OS"60 },61 "version": {62 "type": "string",63 "description": "OS version.",64 "example": "10.15.7"65 }66 },67 "required": [68 "name",69 "version"70 ]71 },72 "timezone": {73 "type": "string",74 "description": "User's timezone.",75 "example": "Asia/Calcutta"76 },77 "screen": {78 "type": "object",79 "description": "Screen resolution details.",80 "properties": {81 "width": {82 "type": "integer",83 "description": "Screen width in pixels.",84 "example": 151285 },86 "height": {87 "type": "integer",88 "description": "Screen height in pixels.",89 "example": 85990 }91 },92 "required": [93 "width",94 "height"95 ]96 },97 "user_agent": {98 "type": "string",99 "description": "User agent information.",100 "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"101 },102 "locale": {103 "type": "string",104 "description": "User's locale information.",105 "example": "en-GB"106 },107 "device": {108 "type": "object",109 "description": "User's device details.",110 "properties": {111 "is_mobile": {112 "type": "boolean",113 "description": "Indicates if the device is mobile or not.",114 "example": false115 }116 },117 "required": [118 "is_mobile"119 ]120 }121 },122 "required": [123 "library",124 "os",125 "timezone",126 "screen",127 "user_agent",128 "locale",129 "device"130 ]131 },132 "event_id": {133 "type": "string",134 "description": "Unique identifier for the order checkout event."135 },136 "event_name": {137 "type": "string",138 "description": "Name of the event, typically \"order_checkout\"."139 },140 "event_type": {141 "type": "string",142 "description": "Type of the event (e.g., \"engagement\").",143 "enum": [144 "engagement",145 "click",146 "conversion",147 "impression",148 "search",149 "identity"150 ]151 },152 "cart_id": {153 "type": "string",154 "description": "Unique identifier for the shopping cart associated with the order."155 },156 "cart_total": {157 "type": "number",158 "description": "Total amount of the cart before taxes and shipping."159 },160 "shipping": {161 "type": "number",162 "description": "Shipping cost associated with the order."163 },164 "order_id": {165 "type": "string",166 "description": "Unique identifier for the order."167 },168 "tax": {169 "type": "number",170 "description": "Tax amount applied to the order."171 },172 "order_total": {173 "type": "number",174 "description": "Total amount of the order including taxes and shipping."175 },176 "products": {177 "type": "array",178 "description": "List of products included in the order.",179 "items": {180 "type": "object",181 "description": "Details of each product in the order.",182 "properties": {183 "product_id": {184 "type": "integer",185 "description": "Unique identifier for the product being ordered."186 },187 "l3_category": {188 "type": "string",189 "x-not-enum": true,190 "description": "Tertiary category of the product."191 },192 "l1_category": {193 "type": "string",194 "x-not-enum": true,195 "description": "Primary category of the product."196 },197 "quantity": {198 "type": "integer",199 "description": "Number of units of the product in the order."200 },201 "price": {202 "type": "number",203 "description": "Price per unit of the product."204 },205 "value": {206 "type": "number",207 "description": "Total value for the product (price multiplied by quantity)."208 },209 "currency": {210 "type": "string",211 "description": "Currency code (e.g., \"USD\", \"INR\") used for the product price."212 },213 "article_id": {214 "type": "string",215 "description": "Unique identifier for the article associated with the product."216 }217 },218 "required": [219 "product_id",220 "l3_category",221 "l1_category",222 "quantity",223 "price",224 "value",225 "currency",226 "article_id"227 ]228 }229 },230 "company_mode": {231 "type": "string",232 "description": "Mode of the company (e.g., \"live\", \"development\").",233 "enum": [234 "live",235 "development"236 ]237 },238 "company_created_on": {239 "type": "string",240 "format": "date-time",241 "description": "Timestamp or detailed information indicating when the company was created. Can be an ISO 8601 string or a complex object with additional details."242 },243 "company_id": {244 "type": "string",245 "description": "Unique identifier for the company associated with the event."246 },247 "version": {248 "type": "string",249 "description": "Version of the event schema."250 },251 "event_timestamp": {252 "type": "string",253 "format": "date-time",254 "description": "ISO 8601 timestamp indicating when the event occurred."255 },256 "user_id": {257 "type": [258 "string",259 "null"260 ],261 "description": "Identifier of the user performing the order checkout action. Use `\"null\"` if the user is anonymous."262 },263 "anonymous_id": {264 "type": "string",265 "description": "Anonymous identifier assigned to the user if they are not logged in."266 },267 "utm_medium": {268 "type": "string",269 "description": "Marketing medium through which the user arrived at the product (e.g., \"email\", \"cpc\")."270 },271 "utm_source": {272 "type": "string",273 "description": "Marketing source driving the traffic to the product (e.g., \"newsletter\", \"google\")."274 },275 "utm_campaign": {276 "type": "string",277 "description": "Specific marketing campaign associated with the product checkout."278 },279 "source_url": {280 "type": "string",281 "description": "URL from which the product was added to the cart."282 }283 }284}
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": 85915 },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": false20 }21 },22 "event_id": "evt_1234567890",23 "event_name": "order_checkout",24 "event_type": "engagement",25 "cart_id": "cart_67890",26 "cart_total": 500.75,27 "shipping": 50,28 "order_id": "order_9876543210",29 "tax": 30.5,30 "order_total": 581.25,31 "products": [32 {33 "product_id": 7818334,34 "l3_category": "Sweatshirts",35 "l1_category": "Clothing",36 "quantity": 1,37 "price": 150.75,38 "currency": "INR",39 "article_id": "art_9876543210"40 }41 ],42 "company_mode": "live",43 "company_created_on": "2020-05-20T08:30:00Z",44 "company_id": "comp_123456",45 "version": "1",46 "event_timestamp": "2025-01-31T12:34:56Z",47 "user_id": "user_12345",48 "anonymous_id": "791392dc-e279-43f9-914c-e8a42a9ee421",49 "utm_medium": "product_recommendation",50 "utm_source": "product_page",51 "utm_campaign": "similar_products",52 "source_url": "https://www.example.com/product/7818334"53}
Was this section helpful?
This event is generated to track order completion events, indicating when a user order has been successfully completed. It provides detailed information about the completed order, including item details, shipment information, and user data.
Events
click/order_complete/conversion/v1
# This event is triggered when a user completes an order on the storefront. It includes detailed information about the order, its contents, and the context in which the order was completed.
Payload
Properties
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.
os
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 event.
event_name
string
Required
Name of the event, typically "order_complete".
event_timestamp
string
| date-time
Required
ISO 8601 timestamp indicating when the event occurred.
version
string
Required
Version of the event schema.
event_type
string
Required
Type of the event (e.g., "engagement").
Enum
order_id
string
Required
Unique identifier for the order.
status
string
Required
Status of the order (e.g., "completed").
breakup_values_raw
object
Required
Detailed breakdown of the order's financials.
Properties
mrp_total
number
Required
Total Maximum Retail Price of all products.
discount
number
Required
Total discount applied to the order.
sub_total
number
Required
Subtotal amount before additional charges.
promotion
number
Required
Total promotion discounts applied.
coupon
number
Required
Total coupon discounts applied.
reward_points
number
Required
Reward points used in the order.
cashback_applied
number
Required
Cashback applied to the order.
cod_charges
number
Required
Cash on Delivery charges, if applicable.
gift_price
number
Required
Total price of gifts included in the order.
delivery_charges
number
Required
Delivery charges for the order.
total
number
Required
Total amount of the order after all adjustments.
shipments
array of object
Required
List of shipments associated with the order.
Array of Properties
shipment_id
string
Required
Unique identifier for the shipment.
status
string
Required
Status of the shipment.
payment_mode
string
Required
Payment mode used for the shipment (e.g., "credit_card", "paypal").
items
array of object
Required
List of items included in the order.
Array of Properties
name
string
Required
Name of the product.
brand
object
Required
Brand details of the product.
Properties
name
string
Required
Name of the brand.
logo
string
Required
URL to the brand's logo.
image
array of string
Required
List of image URLs for the product.
slug_key
string
Required
Slug key for the product URL.
size
string|null
Required
Size of the product. Use `null` if not applicable.
code
string
Required
Unique code for the product.
id
integer
Required
Unique identifier for the product.
category
array of string
Required
List of categories the product belongs to.
l3_category_name
string
Required
Tertiary category name of the product.
l1_categories
array of string
Required
Primary categories of the product.
l2_categories
array of string
Required
Secondary categories of the product.
seller_identifier
string
Required
Identifier for the seller of the product.
attributes
object
Required
Additional attributes of the product.
Properties
brand_name
string
Name of the brand.
media
array|null
List of media URLs related to the product. Use `null` if not applicable.
price
number
Required
Price per unit of the product.
quantity
integer
Required
Quantity of the product ordered.
event_action
string
Required
Specific action related to the event (e.g., "complete_order").
screen
string
Required
Name of the screen where the event occurred.
utm_params
object
Required
UTM parameters associated with the order.
Properties
utm_content
string
Required
Content identifier for the campaign.
utm_medium
string
Required
Marketing medium (e.g., "email", "cpc").
utm_campaign
string
Required
Name of the marketing campaign.
utm_source
string
Required
Source of the marketing traffic (e.g., "newsletter", "google").
screen_view
string
Required
Identifier for the screen view.
user
object
Required
User details.
Properties
_id
string
Required
Unique identifier for the user.
username
string
Required
Username of the user.
emails
array|string
Required
List of user's email addresses.
gender
string
Required
Gender of the user.
active
boolean
Required
Indicates if the user's account is active.
first_name
string
Required
First name of the user.
last_name
string
Required
Last name of the user.
phone_numbers
array|string
Required
List of user's phone numbers.
account_type
string
Required
Type of the user's account.
profile_pic_url
string
Required
URL to the user's profile picture.
user_id
string
Required
Unique identifier for the user in the system.
application_id
string
Required
Identifier for the storefront which user is on.
created_at
string
Required
Timestamp indicating when the user account was created.
updated_at
string
Required
Timestamp indicating when the user account was last updated.
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
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.
user_id
string|null
Identifier of the user performing the order complete 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 "event_type",10 "order_id",11 "status",12 "breakup_values_raw",13 "shipments",14 "items",15 "event_action",16 "screen",17 "utm_params",18 "screen_view",19 "user",20 "company_id",21 "company_mode",22 "company_created_on",23 "version"24 ],25 "description": "Event emitted when a user completes an order on the storefront.",26 "properties": {27 "context": {28 "type": "object",29 "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.",30 "properties": {31 "library": {32 "type": "object",33 "description": "Library information which is sending the event.",34 "properties": {35 "name": {36 "type": "string",37 "description": "Name of the library sending the event.",38 "example": "flick"39 },40 "version": {41 "type": "string",42 "description": "Version of the library.",43 "example": "1.1.1"44 }45 },46 "required": [47 "name",48 "version"49 ]50 },51 "os": {52 "type": "object",53 "description": "Operating system details for the user device.",54 "properties": {55 "name": {56 "type": "string",57 "description": "OS name.",58 "example": "Mac OS"59 },60 "version": {61 "type": "string",62 "description": "OS version.",63 "example": "10.15.7"64 }65 },66 "required": [67 "name",68 "version"69 ]70 },71 "timezone": {72 "type": "string",73 "description": "User's timezone.",74 "example": "Asia/Calcutta"75 },76 "screen": {77 "type": "object",78 "description": "Screen resolution details.",79 "properties": {80 "width": {81 "type": "integer",82 "description": "Screen width in pixels.",83 "example": 151284 },85 "height": {86 "type": "integer",87 "description": "Screen height in pixels.",88 "example": 85989 }90 },91 "required": [92 "width",93 "height"94 ]95 },96 "user_agent": {97 "type": "string",98 "description": "User agent information.",99 "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"100 },101 "locale": {102 "type": "string",103 "description": "User's locale information.",104 "example": "en-GB"105 },106 "device": {107 "type": "object",108 "description": "User's device details.",109 "properties": {110 "is_mobile": {111 "type": "boolean",112 "description": "Indicates if the device is mobile or not.",113 "example": false114 }115 },116 "required": [117 "is_mobile"118 ]119 }120 },121 "required": [122 "library",123 "os",124 "timezone",125 "screen",126 "user_agent",127 "locale",128 "device"129 ]130 },131 "event_id": {132 "type": "string",133 "description": "Unique identifier for the event."134 },135 "event_name": {136 "type": "string",137 "description": "Name of the event, typically \"order_complete\"."138 },139 "event_timestamp": {140 "type": "string",141 "format": "date-time",142 "description": "ISO 8601 timestamp indicating when the event occurred."143 },144 "version": {145 "type": "string",146 "description": "Version of the event schema."147 },148 "event_type": {149 "type": "string",150 "description": "Type of the event (e.g., \"engagement\").",151 "enum": [152 "engagement",153 "click",154 "conversion",155 "impression",156 "search",157 "identity"158 ]159 },160 "order_id": {161 "type": "string",162 "description": "Unique identifier for the order."163 },164 "status": {165 "type": "string",166 "description": "Status of the order (e.g., \"completed\")."167 },168 "breakup_values_raw": {169 "type": "object",170 "description": "Detailed breakdown of the order's financials.",171 "properties": {172 "mrp_total": {173 "type": "number",174 "description": "Total Maximum Retail Price of all products."175 },176 "discount": {177 "type": "number",178 "description": "Total discount applied to the order."179 },180 "sub_total": {181 "type": "number",182 "description": "Subtotal amount before additional charges."183 },184 "promotion": {185 "type": "number",186 "description": "Total promotion discounts applied."187 },188 "coupon": {189 "type": "number",190 "description": "Total coupon discounts applied."191 },192 "reward_points": {193 "type": "number",194 "description": "Reward points used in the order."195 },196 "cashback_applied": {197 "type": "number",198 "description": "Cashback applied to the order."199 },200 "cod_charges": {201 "type": "number",202 "description": "Cash on Delivery charges, if applicable."203 },204 "gift_price": {205 "type": "number",206 "description": "Total price of gifts included in the order."207 },208 "delivery_charges": {209 "type": "number",210 "description": "Delivery charges for the order."211 },212 "total": {213 "type": "number",214 "description": "Total amount of the order after all adjustments."215 }216 },217 "required": [218 "mrp_total",219 "discount",220 "sub_total",221 "promotion",222 "coupon",223 "reward_points",224 "cashback_applied",225 "cod_charges",226 "gift_price",227 "delivery_charges",228 "total"229 ]230 },231 "shipments": {232 "type": "array",233 "description": "List of shipments associated with the order.",234 "items": {235 "type": "object",236 "description": "Details of each shipment.",237 "properties": {238 "shipment_id": {239 "type": "string",240 "description": "Unique identifier for the shipment."241 },242 "status": {243 "type": "string",244 "description": "Status of the shipment."245 },246 "payment_mode": {247 "type": "string",248 "description": "Payment mode used for the shipment (e.g., \"credit_card\", \"paypal\")."249 }250 },251 "required": [252 "shipment_id",253 "status",254 "payment_mode"255 ]256 }257 },258 "items": {259 "type": "array",260 "description": "List of items included in the order.",261 "items": {262 "type": "object",263 "description": "Details of each item in the order.",264 "properties": {265 "name": {266 "type": "string",267 "description": "Name of the product."268 },269 "brand": {270 "type": "object",271 "description": "Brand details of the product.",272 "properties": {273 "name": {274 "type": "string",275 "description": "Name of the brand."276 },277 "logo": {278 "type": "string",279 "description": "URL to the brand's logo."280 }281 },282 "required": [283 "name",284 "logo"285 ]286 },287 "image": {288 "type": "array",289 "description": "List of image URLs for the product.",290 "items": {291 "type": "string"292 }293 },294 "slug_key": {295 "type": "string",296 "description": "Slug key for the product URL."297 },298 "size": {299 "type": [300 "string",301 "null"302 ],303 "description": "Size of the product. Use `null` if not applicable."304 },305 "code": {306 "type": "string",307 "description": "Unique code for the product."308 },309 "id": {310 "type": "integer",311 "description": "Unique identifier for the product."312 },313 "category": {314 "type": "array",315 "description": "List of categories the product belongs to.",316 "items": {317 "type": "string"318 }319 },320 "l3_category_name": {321 "type": "string",322 "description": "Tertiary category name of the product."323 },324 "l1_categories": {325 "type": "array",326 "x-not-enum": true,327 "description": "Primary categories of the product.",328 "items": {329 "type": "string"330 }331 },332 "l2_categories": {333 "type": "array",334 "description": "Secondary categories of the product.",335 "items": {336 "type": "string"337 }338 },339 "seller_identifier": {340 "type": "string",341 "description": "Identifier for the seller of the product."342 },343 "attributes": {344 "type": "object",345 "description": "Additional attributes of the product.",346 "properties": {347 "brand_name": {348 "type": "string",349 "description": "Name of the brand."350 },351 "media": {352 "type": [353 "array",354 "null"355 ],356 "description": "List of media URLs related to the product. Use `null` if not applicable.",357 "items": {358 "type": "string"359 }360 }361 }362 },363 "price": {364 "type": "number",365 "description": "Price per unit of the product."366 },367 "quantity": {368 "type": "integer",369 "description": "Quantity of the product ordered."370 }371 },372 "required": [373 "name",374 "brand",375 "image",376 "slug_key",377 "size",378 "code",379 "id",380 "category",381 "l3_category_name",382 "l1_categories",383 "l2_categories",384 "seller_identifier",385 "attributes",386 "price",387 "quantity"388 ]389 }390 },391 "event_action": {392 "type": "string",393 "description": "Specific action related to the event (e.g., \"complete_order\")."394 },395 "screen": {396 "type": "string",397 "description": "Name of the screen where the event occurred."398 },399 "utm_params": {400 "type": "object",401 "description": "UTM parameters associated with the order.",402 "properties": {403 "utm_content": {404 "type": "string",405 "description": "Content identifier for the campaign."406 },407 "utm_medium": {408 "type": "string",409 "description": "Marketing medium (e.g., \"email\", \"cpc\")."410 },411 "utm_campaign": {412 "type": "string",413 "description": "Name of the marketing campaign."414 },415 "utm_source": {416 "type": "string",417 "description": "Source of the marketing traffic (e.g., \"newsletter\", \"google\")."418 }419 },420 "required": [421 "utm_content",422 "utm_medium",423 "utm_campaign",424 "utm_source"425 ]426 },427 "screen_view": {428 "type": "string",429 "description": "Identifier for the screen view."430 },431 "user": {432 "type": "object",433 "description": "User details.",434 "properties": {435 "_id": {436 "type": "string",437 "description": "Unique identifier for the user."438 },439 "username": {440 "type": "string",441 "description": "Username of the user."442 },443 "emails": {444 "type": [445 "array",446 "string"447 ],448 "description": "List of user's email addresses.",449 "items": {450 "type": "object",451 "description": "Details of each email address.",452 "properties": {453 "email": {454 "type": "string",455 "description": "Email address."456 },457 "active": {458 "type": "boolean",459 "description": "Indicates if the email is active."460 },461 "primary": {462 "type": "boolean",463 "description": "Indicates if the email is primary."464 },465 "verified": {466 "type": "boolean",467 "description": "Indicates if the email is verified."468 }469 },470 "required": [471 "email",472 "active",473 "primary",474 "verified"475 ]476 }477 },478 "gender": {479 "type": "string",480 "description": "Gender of the user."481 },482 "active": {483 "type": "boolean",484 "description": "Indicates if the user's account is active."485 },486 "first_name": {487 "type": "string",488 "description": "First name of the user."489 },490 "last_name": {491 "type": "string",492 "description": "Last name of the user."493 },494 "phone_numbers": {495 "type": [496 "array",497 "string"498 ],499 "description": "List of user's phone numbers.",500 "items": {501 "type": "object",502 "description": "Details of each phone number.",503 "properties": {504 "phone": {505 "type": "string",506 "description": "Phone number."507 },508 "active": {509 "type": "boolean",510 "description": "Indicates if the phone number is active."511 },512 "primary": {513 "type": "boolean",514 "description": "Indicates if the phone number is primary."515 },516 "verified": {517 "type": "boolean",518 "description": "Indicates if the phone number is verified."519 },520 "country_code": {521 "type": "integer",522 "description": "Country code of the phone number."523 }524 },525 "required": [526 "phone",527 "active",528 "primary",529 "verified",530 "country_code"531 ]532 }533 },534 "account_type": {535 "type": "string",536 "description": "Type of the user's account."537 },538 "profile_pic_url": {539 "type": "string",540 "description": "URL to the user's profile picture."541 },542 "user_id": {543 "type": "string",544 "description": "Unique identifier for the user in the system."545 },546 "application_id": {547 "type": "string",548 "description": "Identifier for the storefront which user is on."549 },550 "created_at": {551 "type": "string",552 "description": "Timestamp indicating when the user account was created."553 },554 "updated_at": {555 "type": "string",556 "description": "Timestamp indicating when the user account was last updated."557 }558 },559 "required": [560 "_id",561 "username",562 "emails",563 "gender",564 "active",565 "first_name",566 "last_name",567 "phone_numbers",568 "account_type",569 "profile_pic_url",570 "user_id",571 "application_id",572 "created_at",573 "updated_at"574 ]575 },576 "company_id": {577 "type": "integer",578 "description": "Unique identifier for the company associated with the event."579 },580 "company_mode": {581 "type": "string",582 "description": "Mode of the company (e.g., \"live\", \"development\").",583 "enum": [584 "live",585 "development"586 ]587 },588 "company_created_on": {589 "type": "string",590 "format": "date-time",591 "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"592 },593 "user_id": {594 "type": [595 "string",596 "null"597 ],598 "description": "Identifier of the user performing the order complete action. Use `null` if the user is anonymous."599 },600 "anonymous_id": {601 "type": "string",602 "description": "Anonymous identifier assigned to the user if they are not logged in."603 }604 }605}
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": 85915 },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": false20 }21 },22 "event_id": "evt_1234567890",23 "event_name": "order_complete",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 "event_type": "engagement",29 "order_id": "order_9876543210",30 "status": "completed",31 "breakup_values_raw": {32 "mrp_total": 500,33 "discount": 50,34 "sub_total": 450,35 "promotion": 20,36 "coupon": 10,37 "reward_points": 5,38 "cashback_applied": 15,39 "cod_charges": 0,40 "gift_price": 0,41 "delivery_charges": 30,42 "total": 50043 },44 "shipments": [45 {46 "shipment_id": "ship_12345",47 "status": "shipped",48 "payment_mode": "credit_card"49 }50 ],51 "items": [52 {53 "name": "High-quality sweatshirt",54 "brand": {55 "name": "Armani Exchange",56 "logo": "https://www.example.com/logo.png"57 },58 "image": [59 "https://www.example.com/product/7818334/image1.png",60 "https://www.example.com/product/7818334/image2.png"61 ],62 "slug_key": "high-quality-sweatshirt",63 "size": "M",64 "code": "HW12345",65 "id": 7818334,66 "category": [67 "Clothing",68 "Sweatshirts"69 ],70 "l3_category_name": "Sweatshirts",71 "l1_categories": [72 "Clothing"73 ],74 "l2_categories": [75 "Men's Wear"76 ],77 "seller_identifier": "seller_67890",78 "attributes": {79 "brand_name": "Armani Exchange",80 "media": [81 "https://www.example.com/media/video1.mp4",82 "https://www.example.com/media/video2.mp4"83 ]84 },85 "price": 150.75,86 "quantity": 187 }88 ],89 "event_action": "complete_order",90 "screen": "Order Confirmation Page",91 "utm_params": {92 "utm_content": "summer_promo",93 "utm_medium": "email",94 "utm_campaign": "summer_sale",95 "utm_source": "newsletter"96 },97 "screen_view": "order_confirmation_screen",98 "user": {99 "_id": "user_12345",100 "username": "test_example_com_12345",101 "emails": [102 {103 "email": "test@example.com",104 "active": true,105 "primary": true,106 "verified": true107 }108 ],109 "gender": "male",110 "active": true,111 "first_name": "John",112 "last_name": "Doe",113 "phone_numbers": [114 {115 "phone": "8888888888",116 "active": true,117 "primary": true,118 "verified": true,119 "country_code": 1120 }121 ],122 "account_type": "standard",123 "profile_pic_url": "https://www.example.com/users/john_doe/profile.jpg",124 "user_id": "user_12345",125 "application_id": "app_98765",126 "created_at": "2020-05-20T08:30:00Z",127 "updated_at": "2025-01-31T12:34:56Z"128 },129 "company_id": 123456,130 "company_mode": "live",131 "company_created_on": "2020-05-20T08:30:00Z"132}
Was this section helpful?
This event is generated to track product listing events, indicating when a user visits the product listing. It provides essential information about the user events.
Events
click/product_listing/conversion/v1
# This event is emitted when a user visits the product listing.
Payload
Properties
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.
os
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 event.
event_name
string
Required
Name of the event, typically "product_listing".
version
string
Required
Version of the event schema.
event_type
string
Required
Type of the event (e.g., "engagement").
Enum
query
string|null
Search query used. Use `null` if no search was performed.
search_id
string|null
Required
Unique identifier for the search. Use `null` if no search was performed.
products
array of object
Required
List of products in the event.
Array of Properties
product_id
integer
Required
Product ID.
name
string
Required
Product name.
currency
string
Required
Currency code.
mrp
integer
Required
Maximum retail price.
esp
integer
Required
Effective selling price.
source_url
string
Required
Product source URL.
brand
string
Required
Brand name.
item_total
integer
Required
Total number of items.
company_id
integer
Required
Company identifier.
company_mode
string
Required
Mode of the company (e.g., "live", "development").
Enum
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.
event_timestamp
string
| date-time
Required
Timestamp of the event.
user_id
string|null
Identifier of the user performing the product listing 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 "event_type",10 "search_id",11 "products",12 "item_total",13 "company_id",14 "company_mode",15 "company_created_on",16 "version"17 ],18 "description": "Event emitted when a user views product listing on the storefront.",19 "properties": {20 "context": {21 "type": "object",22 "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.",23 "properties": {24 "library": {25 "type": "object",26 "description": "Library information which is sending the event.",27 "properties": {28 "name": {29 "type": "string",30 "description": "Name of the library sending the event.",31 "example": "flick"32 },33 "version": {34 "type": "string",35 "description": "Version of the library.",36 "example": "1.1.1"37 }38 },39 "required": [40 "name",41 "version"42 ]43 },44 "os": {45 "type": "object",46 "description": "Operating system details for the user device.",47 "properties": {48 "name": {49 "type": "string",50 "description": "OS name.",51 "example": "Mac OS"52 },53 "version": {54 "type": "string",55 "description": "OS version.",56 "example": "10.15.7"57 }58 },59 "required": [60 "name",61 "version"62 ]63 },64 "timezone": {65 "type": "string",66 "description": "User's timezone.",67 "example": "Asia/Calcutta"68 },69 "screen": {70 "type": "object",71 "description": "Screen resolution details.",72 "properties": {73 "width": {74 "type": "integer",75 "description": "Screen width in pixels.",76 "example": 151277 },78 "height": {79 "type": "integer",80 "description": "Screen height in pixels.",81 "example": 85982 }83 },84 "required": [85 "width",86 "height"87 ]88 },89 "user_agent": {90 "type": "string",91 "description": "User agent information.",92 "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"93 },94 "locale": {95 "type": "string",96 "description": "User's locale information.",97 "example": "en-GB"98 },99 "device": {100 "type": "object",101 "description": "User's device details.",102 "properties": {103 "is_mobile": {104 "type": "boolean",105 "description": "Indicates if the device is mobile or not.",106 "example": false107 }108 },109 "required": [110 "is_mobile"111 ]112 }113 },114 "required": [115 "library",116 "os",117 "timezone",118 "screen",119 "user_agent",120 "locale",121 "device"122 ]123 },124 "event_id": {125 "type": "string",126 "description": "Unique identifier for the event."127 },128 "event_name": {129 "type": "string",130 "description": "Name of the event, typically \"product_listing\"."131 },132 "version": {133 "type": "string",134 "description": "Version of the event schema."135 },136 "event_type": {137 "type": "string",138 "description": "Type of the event (e.g., \"engagement\").",139 "enum": [140 "engagement",141 "click",142 "conversion",143 "impression",144 "search",145 "identity"146 ]147 },148 "query": {149 "type": [150 "string",151 "null"152 ],153 "description": "Search query used. Use `null` if no search was performed."154 },155 "search_id": {156 "type": [157 "string",158 "null"159 ],160 "description": "Unique identifier for the search. Use `null` if no search was performed."161 },162 "products": {163 "type": "array",164 "description": "List of products in the event.",165 "items": {166 "type": "object",167 "description": "Details of each product in the listing.",168 "properties": {169 "product_id": {170 "type": "integer",171 "description": "Product ID."172 },173 "name": {174 "type": "string",175 "description": "Product name."176 },177 "currency": {178 "type": "string",179 "description": "Currency code."180 },181 "mrp": {182 "type": "integer",183 "description": "Maximum retail price."184 },185 "esp": {186 "type": "integer",187 "description": "Effective selling price."188 },189 "source_url": {190 "type": "string",191 "description": "Product source URL."192 },193 "brand": {194 "type": "string",195 "description": "Brand name."196 }197 },198 "required": [199 "product_id",200 "name",201 "currency",202 "mrp",203 "esp",204 "source_url",205 "brand"206 ]207 }208 },209 "item_total": {210 "type": "integer",211 "description": "Total number of items."212 },213 "company_id": {214 "type": "integer",215 "description": "Company identifier."216 },217 "company_mode": {218 "type": "string",219 "description": "Mode of the company (e.g., \"live\", \"development\").",220 "enum": [221 "live",222 "development"223 ]224 },225 "company_created_on": {226 "type": "string",227 "format": "date-time",228 "description": "Timestamp or detailed information indicating when the company was created. Can be an ISO 8601 string or a complex object with additional details."229 },230 "event_timestamp": {231 "type": "string",232 "format": "date-time",233 "description": "Timestamp of the event."234 },235 "user_id": {236 "type": [237 "string",238 "null"239 ],240 "description": "Identifier of the user performing the product listing action. Use `null` if the user is anonymous."241 },242 "anonymous_id": {243 "type": "string",244 "description": "Anonymous identifier assigned to the user if they are not logged in."245 }246 }247}
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": 85915 },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": false20 }21 },22 "event_id": "evt_1234567890",23 "event_name": "product_listing",24 "version": "1",25 "event_timestamp": "2025-01-31T12:34:56Z",26 "anonymous_id": "791392dc-e279-43f9-914c-e8a42a9ee421",27 "event_type": "impression",28 "query": "summer dresses",29 "search_id": "search_9876543210",30 "products": [31 {32 "product_id": 2001,33 "name": "Zara Floral Maxi Dress",34 "currency": "USD",35 "mrp": 80,36 "esp": 60,37 "source_url": "https://www.example.com/products/2001",38 "brand": "Zara"39 },40 {41 "product_id": 2002,42 "name": "H&M Sleeveless Dress",43 "currency": "USD",44 "mrp": 50,45 "esp": 40,46 "source_url": "https://www.example.com/products/2002",47 "brand": "H&M"48 }49 ],50 "item_total": 2,51 "company_id": 654321,52 "company_mode": "live",53 "company_created_on": "2020-05-20T08:30:00Z",54 "user_id": null55}
Was this section helpful?
This event is triggered when the pincode servicabilty is checked on the product view page. This event is triggered along with location_details and delivery_promise and provides the product details for the pincode being checked. It provides comprehensive details about the user, the product details, and the context in which the event 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/product_price/click/v1
# This event is triggered when the pincode servicabilty is checked on the product view page. It includes detailed information about the user, the pincode added and details about the version of the library and the device information like os, screen size, timezone etc.
Payload
Properties
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.
os
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.
query
string|null
Search query entered by the user, if applicable. Use `null` if not applicable.
user_id
string|null
Identifier of the user performing the product_details action. Use `null` if the user is anonymous.
version
string
Required
Version of the event schema.
currency
string
Required
Currency associated with the country pincode being checked.
event_id
string
Required
Unique identifier for the event.
article_id
string
Required
Unique identifier for the article associated with the product.
store_id
integer
Required
Store id associated with the product.
seller_id
integer
Required
Seller id associated with the product.
country_iso_code
string
Required
ISO code associated with the country for the pincode being checked.
city
string
Required
City associated with the pincode being checked.
country
string
Required
Country associated with the pincode being checked.
pincode
string
Required
Pincode being checked.
sector
string|null
Sector associated with pincode being checked.
position
string|null
Position of the product in the listing when it was clicked on. Use `null` if not applicable.
search_id
string|null
Identifier for the search journey, if applicable. Use `null` if not applicable.
company_id
integer
Unique identifier for the company associated with the event.
event_name
string
Required
Name of the event, typically "location_details".
event_type
string
Required
Type of the event (e.g., "click").
Enum
anonymous_id
string
Required
Anonymous identifier for the user.
company_mode
string
Mode of the company (e.g., "live", "development").
Enum
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
Timestamp of the event.
company_created_on
string
| date-time
Timestamp or detailed information indicating when the company was created.
Can be an ISO 8601 string or a complex object with additional details.
Payload Schema JSON
1{2 "type": "object",3 "required": [4 "context",5 "anonymous_id",6 "pincode",7 "country",8 "currency",9 "version",10 "event_id",11 "article_id",12 "city",13 "event_name",14 "event_type",15 "store_id",16 "seller_id",17 "country_iso_code"18 ],19 "description": "Event emitted when a user checks any pincode for servicability.",20 "properties": {21 "context": {22 "type": "object",23 "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.",24 "properties": {25 "library": {26 "type": "object",27 "description": "Library information which is sending the event.",28 "properties": {29 "name": {30 "type": "string",31 "description": "Name of the library sending the event.",32 "example": "flick"33 },34 "version": {35 "type": "string",36 "description": "Version of the library.",37 "example": "1.1.1"38 }39 },40 "required": [41 "name",42 "version"43 ]44 },45 "os": {46 "type": "object",47 "description": "Operating system details for the user device.",48 "properties": {49 "name": {50 "type": "string",51 "description": "OS name.",52 "example": "Mac OS"53 },54 "version": {55 "type": "string",56 "description": "OS version.",57 "example": "10.15.7"58 }59 },60 "required": [61 "name",62 "version"63 ]64 },65 "timezone": {66 "type": "string",67 "description": "User's timezone.",68 "example": "Asia/Calcutta"69 },70 "screen": {71 "type": "object",72 "description": "Screen resolution details.",73 "properties": {74 "width": {75 "type": "integer",76 "description": "Screen width in pixels.",77 "example": 151278 },79 "height": {80 "type": "integer",81 "description": "Screen height in pixels.",82 "example": 85983 }84 },85 "required": [86 "width",87 "height"88 ]89 },90 "user_agent": {91 "type": "string",92 "description": "User agent information.",93 "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"94 },95 "locale": {96 "type": "string",97 "description": "User's locale information.",98 "example": "en-GB"99 },100 "device": {101 "type": "object",102 "description": "User's device details.",103 "properties": {104 "is_mobile": {105 "type": "boolean",106 "description": "Indicates if the device is mobile or not.",107 "example": false108 }109 },110 "required": [111 "is_mobile"112 ]113 }114 },115 "required": [116 "library",117 "os",118 "timezone",119 "screen",120 "user_agent",121 "locale",122 "device"123 ]124 },125 "query": {126 "type": [127 "string",128 "null"129 ],130 "description": "Search query entered by the user, if applicable. Use `null` if not applicable."131 },132 "user_id": {133 "type": [134 "string",135 "null"136 ],137 "description": "Identifier of the user performing the product_details action. Use `null` if the user is anonymous."138 },139 "version": {140 "type": "string",141 "description": "Version of the event schema."142 },143 "currency": {144 "type": "string",145 "description": "Currency associated with the country pincode being checked."146 },147 "event_id": {148 "type": "string",149 "description": "Unique identifier for the event."150 },151 "article_id": {152 "type": "string",153 "description": "Unique identifier for the article associated with the product."154 },155 "store_id": {156 "type": "integer",157 "description": "Store id associated with the product."158 },159 "seller_id": {160 "type": "integer",161 "description": "Seller id associated with the product."162 },163 "country_iso_code": {164 "type": "string",165 "x-not-enum": true,166 "description": "ISO code associated with the country for the pincode being checked."167 },168 "city": {169 "type": "string",170 "description": "City associated with the pincode being checked."171 },172 "country": {173 "type": "string",174 "description": "Country associated with the pincode being checked."175 },176 "pincode": {177 "type": "string",178 "description": "Pincode being checked."179 },180 "sector": {181 "type": [182 "string",183 "null"184 ],185 "description": "Sector associated with pincode being checked."186 },187 "position": {188 "type": [189 "string",190 "null"191 ],192 "description": "Position of the product in the listing when it was clicked on. Use `null` if not applicable."193 },194 "search_id": {195 "type": [196 "string",197 "null"198 ],199 "description": "Identifier for the search journey, if applicable. Use `null` if not applicable."200 },201 "company_id": {202 "type": "integer",203 "description": "Unique identifier for the company associated with the event."204 },205 "event_name": {206 "type": "string",207 "description": "Name of the event, typically \"location_details\"."208 },209 "event_type": {210 "type": "string",211 "description": "Type of the event (e.g., \"click\").",212 "enum": [213 "engagement",214 "click",215 "conversion",216 "impression",217 "search",218 "identity"219 ]220 },221 "anonymous_id": {222 "type": "string",223 "description": "Anonymous identifier for the user."224 },225 "company_mode": {226 "type": "string",227 "description": "Mode of the company (e.g., \"live\", \"development\").",228 "enum": [229 "live",230 "development"231 ]232 },233 "utm_campaign": {234 "type": "string",235 "description": "Specific marketing campaign associated with the product addition."236 },237 "utm_medium": {238 "type": "string",239 "description": "Marketing medium through which the user arrived at the product."240 },241 "utm_source": {242 "type": "string",243 "description": "Marketing source driving the traffic to the product."244 },245 "event_timestamp": {246 "type": "string",247 "format": "date-time",248 "description": "Timestamp of the event."249 },250 "company_created_on": {251 "type": "string",252 "format": "date-time",253 "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"254 }255 }256}
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": 85915 },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": false20 }21 },22 "event_id": "evt_1234567890",23 "event_name": "product_price",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 "company_created_on": "2020-05-20T08:30:00Z",29 "company_id": 123456,30 "company_mode": "live",31 "currency": "INR",32 "event_type": "click",33 "city": "Mumbai",34 "country": "India",35 "article_id": "1233q332",36 "store_id": 123,37 "seller_id": 1234,38 "pincode": 400068,39 "position": "2",40 "country_iso_code": "IN",41 "query": "allen solly",42 "search_id": "search_67890",43 "utm_campaign": "similar_products",44 "utm_medium": "product_recommendation",45 "utm_source": "product_page"46}
Was this section helpful?
This event generated to track the products searched by the user. It captures actions such as search queries performed along with the query entered by the user. It also provides details like user device and user details to be used for analytical purposes.
Events
click/product_search/search/v1
# This event is triggered when a user interacts with the product search functionality on the storefront.
Payload
Properties
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.
os
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 event.
event_name
string
Required
Name of the event, typically "product_search".
version
string
Required
Version of the event schema.
event_type
string
Required
Type of the event (e.g., "engagement").
Enum
query
string
Required
Search query entered by the user.
products
array of string
Required
List of product names returned from the search.
item_total
integer|null
Total number of items found. Use `null` if not applicable.
source
string
Required
Source of the search event.
Enum
company_id
integer
Required
ID of the company.
company_mode
string
Required
Mode of the company (e.g., "live", "development").
Enum
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.
event_timestamp
string
| date-time
Required
Timestamp of the event.
user_id
string|null
Identifier of the user performing the product search 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 "event_type",10 "query",11 "products",12 "source",13 "company_id",14 "company_mode",15 "company_created_on",16 "version"17 ],18 "description": "Event emitted when a user performs a product search on the storefront.",19 "properties": {20 "context": {21 "type": "object",22 "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.",23 "properties": {24 "library": {25 "type": "object",26 "description": "Library information which is sending the event.",27 "properties": {28 "name": {29 "type": "string",30 "description": "Name of the library sending the event.",31 "example": "flick"32 },33 "version": {34 "type": "string",35 "description": "Version of the library.",36 "example": "1.1.1"37 }38 },39 "required": [40 "name",41 "version"42 ]43 },44 "os": {45 "type": "object",46 "description": "Operating system details for the user device.",47 "properties": {48 "name": {49 "type": "string",50 "description": "OS name.",51 "example": "Mac OS"52 },53 "version": {54 "type": "string",55 "description": "OS version.",56 "example": "10.15.7"57 }58 },59 "required": [60 "name",61 "version"62 ]63 },64 "timezone": {65 "type": "string",66 "description": "User's timezone.",67 "example": "Asia/Calcutta"68 },69 "screen": {70 "type": "object",71 "description": "Screen resolution details.",72 "properties": {73 "width": {74 "type": "integer",75 "description": "Screen width in pixels.",76 "example": 151277 },78 "height": {79 "type": "integer",80 "description": "Screen height in pixels.",81 "example": 85982 }83 },84 "required": [85 "width",86 "height"87 ]88 },89 "user_agent": {90 "type": "string",91 "description": "User agent information.",92 "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"93 },94 "locale": {95 "type": "string",96 "description": "User's locale information.",97 "example": "en-GB"98 },99 "device": {100 "type": "object",101 "description": "User's device details.",102 "properties": {103 "is_mobile": {104 "type": "boolean",105 "description": "Indicates if the device is mobile or not.",106 "example": false107 }108 },109 "required": [110 "is_mobile"111 ]112 }113 },114 "required": [115 "library",116 "os",117 "timezone",118 "screen",119 "user_agent",120 "locale",121 "device"122 ]123 },124 "event_id": {125 "type": "string",126 "description": "Unique identifier for the event."127 },128 "event_name": {129 "type": "string",130 "description": "Name of the event, typically \"product_search\"."131 },132 "version": {133 "type": "string",134 "description": "Version of the event schema."135 },136 "event_type": {137 "type": "string",138 "description": "Type of the event (e.g., \"engagement\").",139 "enum": [140 "engagement",141 "click",142 "conversion",143 "impression",144 "search",145 "identity"146 ]147 },148 "query": {149 "type": "string",150 "description": "Search query entered by the user."151 },152 "products": {153 "type": "array",154 "description": "List of product names returned from the search.",155 "items": {156 "type": "string"157 }158 },159 "item_total": {160 "type": [161 "integer",162 "null"163 ],164 "description": "Total number of items found. Use `null` if not applicable."165 },166 "source": {167 "type": "string",168 "enum": [169 "autocomplete",170 "product-search"171 ],172 "description": "Source of the search event."173 },174 "company_id": {175 "type": "integer",176 "description": "ID of the company."177 },178 "company_mode": {179 "type": "string",180 "description": "Mode of the company (e.g., \"live\", \"development\").",181 "enum": [182 "live",183 "development"184 ]185 },186 "company_created_on": {187 "type": "string",188 "format": "date-time",189 "description": "Timestamp or detailed information indicating when the company was created. Can be an ISO 8601 string or a complex object with additional details."190 },191 "event_timestamp": {192 "type": "string",193 "format": "date-time",194 "description": "Timestamp of the event."195 },196 "user_id": {197 "type": [198 "string",199 "null"200 ],201 "description": "Identifier of the user performing the product search action. Use `null` if the user is anonymous."202 },203 "anonymous_id": {204 "type": "string",205 "description": "Anonymous identifier assigned to the user if they are not logged in."206 }207 }208}
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": 85915 },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": false20 }21 },22 "event_id": "evt_1234567890",23 "event_name": "product_search",24 "version": "1",25 "event_timestamp": "2025-01-31T12:34:56Z",26 "anonymous_id": "791392dc-e279-43f9-914c-e8a42a9ee421",27 "event_type": "search",28 "query": "running shoes",29 "products": [30 "Nike Air Zoom Pegasus",31 "Adidas Ultraboost",32 "Puma RS-X"33 ],34 "item_total": 3,35 "source": "product-search",36 "company_id": 123456,37 "company_mode": "live",38 "company_created_on": "2020-05-20T08:30:00Z",39 "user_id": "user_12345"40}
Was this section helpful?
This event is triggered when the user views a product within the storefront. It captures details such as product ID, category, price, and user information, providing valuable insights for analytical and marketing purposes.
Events
click/product_view/click/v1
# This event is triggered when a user views a product. It includes detailed information about the user, the product viewed, and the surrounding context of the event. Context here implies details about the version of the library sending the event and the device information like os, screen size, timezone etc.
This event is triggered when a user views a product. It includes detailed information about the user, the product viewed, and the surrounding context of the event. Context here implies details about the version of the library sending the event and the device information like os, screen size, timezone etc.
Payload
Properties
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.
os
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 product view event.
event_name
string
Required
Name of the event, typically "product_view".
version
string
Required
Version of the event schema.
event_timestamp
string
| date-time
Required
ISO 8601 timestamp indicating when the event occurred.
user_id
string|null
Identifier of the user performing the product view action. Use `"null"` if the user is anonymous.
anonymous_id
string
Required
Anonymous identifier assigned to the user if they are not logged in.
esp
integer
Required
ESP-related metric associated with the product view action. *(Please provide more context if specific.)*
mrp
integer
Required
Maximum Retail Price of the product being viewed.
brand
string
Required
Brand name of the product viewed.
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).
query
string|null
Search query entered by the user, if applicable. Use `"null"` if not applicable.
position
string|null
Position of the product on the page. Use `"null"` if not applicable.
utm_medium
string
Marketing medium through which the user arrived at the product (e.g., "email", "cpc").
utm_source
string
Marketing source driving the traffic to the product (e.g., "newsletter", "google").
utm_campaign
string
Specific marketing campaign associated with the product view.
product_id
integer
Required
Unique identifier for the product being viewed.
quantity
integer
Required
Number of units of the product viewed. *(Typically 1, but can vary if applicable.)*
search_id
string|null
Identifier for the search session, if applicable. Use `"null"` if not applicable.
source_url
string
Required
URL from which the product was viewed.
Payload Schema JSON
1{2 "type": "object",3 "required": [4 "context",5 "event_id",6 "event_name",7 "event_timestamp",8 "anonymous_id",9 "esp",10 "mrp",11 "source_url",12 "quantity",13 "product_id",14 "l1_category",15 "l3_category",16 "brand",17 "currency",18 "event_type",19 "version",20 "company_created_on",21 "company_id",22 "company_mode"23 ],24 "description": "Event emitted when a user views a product.",25 "properties": {26 "context": {27 "type": "object",28 "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.",29 "properties": {30 "library": {31 "type": "object",32 "description": "Library information which is sending the event.",33 "properties": {34 "name": {35 "type": "string",36 "description": "Name of the library sending the event.",37 "example": "flick"38 },39 "version": {40 "type": "string",41 "description": "Version of the library.",42 "example": "1.1.1"43 }44 },45 "required": [46 "name",47 "version"48 ]49 },50 "os": {51 "type": "object",52 "description": "Operating system details for the user device.",53 "properties": {54 "name": {55 "type": "string",56 "description": "OS name.",57 "example": "Mac OS"58 },59 "version": {60 "type": "string",61 "description": "OS version.",62 "example": "10.15.7"63 }64 },65 "required": [66 "name",67 "version"68 ]69 },70 "timezone": {71 "type": "string",72 "description": "User's timezone.",73 "example": "Asia/Calcutta"74 },75 "screen": {76 "type": "object",77 "description": "Screen resolution details.",78 "properties": {79 "width": {80 "type": "integer",81 "description": "Screen width in pixels.",82 "example": 151283 },84 "height": {85 "type": "integer",86 "description": "Screen height in pixels.",87 "example": 85988 }89 },90 "required": [91 "width",92 "height"93 ]94 },95 "user_agent": {96 "type": "string",97 "description": "User agent information.",98 "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"99 },100 "locale": {101 "type": "string",102 "description": "User's locale information.",103 "example": "en-GB"104 },105 "device": {106 "type": "object",107 "description": "User's device details.",108 "properties": {109 "is_mobile": {110 "type": "boolean",111 "description": "Indicates if the device is mobile or not.",112 "example": false113 }114 },115 "required": [116 "is_mobile"117 ]118 }119 },120 "required": [121 "library",122 "os",123 "timezone",124 "screen",125 "user_agent",126 "locale",127 "device"128 ]129 },130 "event_id": {131 "type": "string",132 "description": "Unique identifier for the product view event."133 },134 "event_name": {135 "type": "string",136 "description": "Name of the event, typically \"product_view\"."137 },138 "version": {139 "type": "string",140 "description": "Version of the event schema."141 },142 "event_timestamp": {143 "type": "string",144 "format": "date-time",145 "description": "ISO 8601 timestamp indicating when the event occurred."146 },147 "user_id": {148 "type": [149 "string",150 "null"151 ],152 "description": "Identifier of the user performing the product view action. Use `\"null\"` if the user is anonymous."153 },154 "anonymous_id": {155 "type": "string",156 "description": "Anonymous identifier assigned to the user if they are not logged in."157 },158 "esp": {159 "type": "integer",160 "description": "ESP-related metric associated with the product view action. *(Please provide more context if specific.)*"161 },162 "mrp": {163 "type": "integer",164 "description": "Maximum Retail Price of the product being viewed."165 },166 "brand": {167 "type": "string",168 "description": "Brand name of the product viewed."169 },170 "company_created_on": {171 "type": "string",172 "format": "date-time",173 "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"174 },175 "company_id": {176 "type": "integer",177 "description": "Unique identifier for the company associated with the event."178 },179 "company_mode": {180 "type": "string",181 "description": "Mode of the company (e.g., \"live\", \"development\").",182 "enum": [183 "live",184 "development"185 ]186 },187 "currency": {188 "type": "string",189 "description": "Currency code (e.g., \"USD\", \"INR\") used for the product price."190 },191 "event_type": {192 "type": "string",193 "description": "Type of the event (e.g., \"engagement\").",194 "enum": [195 "engagement",196 "click",197 "conversion",198 "impression",199 "search",200 "identity"201 ]202 },203 "l1_category": {204 "type": "string",205 "x-not-enum": true,206 "description": "Primary category of the product (Level 1)."207 },208 "l3_category": {209 "type": "string",210 "x-not-enum": true,211 "description": "Tertiary category of the product (Level 3)."212 },213 "query": {214 "type": [215 "string",216 "null"217 ],218 "description": "Search query entered by the user, if applicable. Use `\"null\"` if not applicable."219 },220 "position": {221 "type": [222 "string",223 "null"224 ],225 "description": "Position of the product on the page. Use `\"null\"` if not applicable."226 },227 "utm_medium": {228 "type": "string",229 "description": "Marketing medium through which the user arrived at the product (e.g., \"email\", \"cpc\")."230 },231 "utm_source": {232 "type": "string",233 "description": "Marketing source driving the traffic to the product (e.g., \"newsletter\", \"google\")."234 },235 "utm_campaign": {236 "type": "string",237 "description": "Specific marketing campaign associated with the product view."238 },239 "product_id": {240 "type": "integer",241 "description": "Unique identifier for the product being viewed."242 },243 "quantity": {244 "type": "integer",245 "description": "Number of units of the product viewed. *(Typically 1, but can vary if applicable.)*"246 },247 "search_id": {248 "type": [249 "string",250 "null"251 ],252 "description": "Identifier for the search session, if applicable. Use `\"null\"` if not applicable."253 },254 "source_url": {255 "type": "string",256 "description": "URL from which the product was viewed."257 }258 }259}
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": 85915 },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": false20 }21 },22 "event_id": "evt_1234567890",23 "event_name": "product_view",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 "esp": 50,29 "mrp": 150,30 "brand": "Armani Exchange",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 "query": "allen solly",39 "position": "top",40 "utm_medium": "product_recommendation",41 "utm_source": "product_page",42 "utm_campaign": "similar_products",43 "product_id": 7818334,44 "quantity": 1,45 "search_id": "search_67890",46 "source_url": "https://www.example.com/product/7818334"47}
Was this section helpful?
This event is triggered when a user adds a product to their wishlist within the storefront. It captures details such as wishlist name, ID, product details, and user information, providing valuable insights for tracking user engagement and preferences.
Events
click/product_wishlist_add/engagement/v1
# This event is triggered when a user adds a product to their wishlist on the storefront. It includes detailed information about the user, the product added, and the context in which the addition occurs.
Payload
Properties
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.
os
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 product wishlist add event.
event_name
string
Required
Name of the event, typically "product_wishlist_add".
version
string
Required
Version of the event schema.
brand
string
Required
Brand name of the product added to the wishlist.
cart_id
string
Required
Unique identifier for the shopping cart associated with the wishlist.
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|null
Required
Currency code (e.g., "USD", "INR") used for the product price.
esp
number|null
Required
ESP-related metric associated with the wishlist add action. *(Please provide more context if specific.)*
event_type
string
Required
Type of the event (e.g., "engagement").
Enum
l3_category
string
Required
Tertiary category of the product.
mrp
number|null
Required
Maximum Retail Price of the product being added to the wishlist.
position
string|null
Required
Position of the product in the wishlist or on the page. Use `"null"` if not applicable.
product_id
integer
Required
Unique identifier for the product being added to the wishlist.
quantity
string
Required
Quantity of the product added to the wishlist. *(Typically 1, but can vary if applicable.)*
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 session, if applicable. Use `"null"` if not applicable.
source_url
string
Required
URL from which the product was added to the wishlist.
utm_campaign
string
Specific marketing campaign associated with the wishlist addition.
utm_medium
string
Marketing medium through which the user arrived at the product (e.g., "email", "cpc").
utm_source
string
Marketing source driving the traffic to the product (e.g., "newsletter", "google").
wishlist_id
string
Required
Unique identifier for the wishlist.
wishlist_name
string
Required
Name of the wishlist.
event_timestamp
string
| date-time
Required
ISO 8601 timestamp indicating when the event occurred.
user_id
string
Identifier of the user performing the wishlist add 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 "esp",17 "event_type",18 "l3_category",19 "mrp",20 "position",21 "product_id",22 "quantity",23 "query",24 "search_id",25 "source_url",26 "wishlist_id",27 "wishlist_name",28 "version"29 ],30 "description": "Event emitted when a user adds a product to their wishlist on the storefront.",31 "properties": {32 "context": {33 "type": "object",34 "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.",35 "properties": {36 "library": {37 "type": "object",38 "description": "Library information which is sending the event.",39 "properties": {40 "name": {41 "type": "string",42 "description": "Name of the library sending the event.",43 "example": "flick"44 },45 "version": {46 "type": "string",47 "description": "Version of the library.",48 "example": "1.1.1"49 }50 },51 "required": [52 "name",53 "version"54 ]55 },56 "os": {57 "type": "object",58 "description": "Operating system details for the user device.",59 "properties": {60 "name": {61 "type": "string",62 "description": "OS name.",63 "example": "Mac OS"64 },65 "version": {66 "type": "string",67 "description": "OS version.",68 "example": "10.15.7"69 }70 },71 "required": [72 "name",73 "version"74 ]75 },76 "timezone": {77 "type": "string",78 "description": "User's timezone.",79 "example": "Asia/Calcutta"80 },81 "screen": {82 "type": "object",83 "description": "Screen resolution details.",84 "properties": {85 "width": {86 "type": "integer",87 "description": "Screen width in pixels.",88 "example": 151289 },90 "height": {91 "type": "integer",92 "description": "Screen height in pixels.",93 "example": 85994 }95 },96 "required": [97 "width",98 "height"99 ]100 },101 "user_agent": {102 "type": "string",103 "description": "User agent information.",104 "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"105 },106 "locale": {107 "type": "string",108 "description": "User's locale information.",109 "example": "en-GB"110 },111 "device": {112 "type": "object",113 "description": "User's device details.",114 "properties": {115 "is_mobile": {116 "type": "boolean",117 "description": "Indicates if the device is mobile or not.",118 "example": false119 }120 },121 "required": [122 "is_mobile"123 ]124 }125 },126 "required": [127 "library",128 "os",129 "timezone",130 "screen",131 "user_agent",132 "locale",133 "device"134 ]135 },136 "event_id": {137 "type": "string",138 "description": "Unique identifier for the product wishlist add event."139 },140 "event_name": {141 "type": "string",142 "description": "Name of the event, typically \"product_wishlist_add\"."143 },144 "version": {145 "type": "string",146 "description": "Version of the event schema."147 },148 "brand": {149 "type": "string",150 "description": "Brand name of the product added to the wishlist."151 },152 "cart_id": {153 "type": "string",154 "description": "Unique identifier for the shopping cart associated with the wishlist."155 },156 "company_created_on": {157 "type": "string",158 "format": "date-time",159 "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"160 },161 "company_id": {162 "type": "integer",163 "description": "Unique identifier for the company associated with the event."164 },165 "company_mode": {166 "type": "string",167 "description": "Mode of the company (e.g., \"live\", \"development\").",168 "enum": [169 "live",170 "development"171 ]172 },173 "currency": {174 "type": [175 "string",176 "null"177 ],178 "description": "Currency code (e.g., \"USD\", \"INR\") used for the product price."179 },180 "esp": {181 "type": [182 "number",183 "null"184 ],185 "description": "ESP-related metric associated with the wishlist add action. *(Please provide more context if specific.)*"186 },187 "event_type": {188 "type": "string",189 "description": "Type of the event (e.g., \"engagement\").",190 "enum": [191 "engagement",192 "click",193 "conversion",194 "impression",195 "search",196 "identity"197 ]198 },199 "l3_category": {200 "type": "string",201 "x-not-enum": true,202 "description": "Tertiary category of the product."203 },204 "mrp": {205 "type": [206 "number",207 "null"208 ],209 "description": "Maximum Retail Price of the product being added to the wishlist."210 },211 "position": {212 "type": [213 "string",214 "null"215 ],216 "description": "Position of the product in the wishlist or on the page. Use `\"null\"` if not applicable."217 },218 "product_id": {219 "type": "integer",220 "description": "Unique identifier for the product being added to the wishlist."221 },222 "quantity": {223 "type": "string",224 "description": "Quantity of the product added to the wishlist. *(Typically 1, but can vary if applicable.)*"225 },226 "query": {227 "type": [228 "string",229 "null"230 ],231 "description": "Search query entered by the user, if applicable. Use `\"null\"` if not applicable."232 },233 "search_id": {234 "type": [235 "string",236 "null"237 ],238 "description": "Identifier for the search session, if applicable. Use `\"null\"` if not applicable."239 },240 "source_url": {241 "type": "string",242 "description": "URL from which the product was added to the wishlist."243 },244 "utm_campaign": {245 "type": "string",246 "description": "Specific marketing campaign associated with the wishlist addition."247 },248 "utm_medium": {249 "type": "string",250 "description": "Marketing medium through which the user arrived at the product (e.g., \"email\", \"cpc\")."251 },252 "utm_source": {253 "type": "string",254 "description": "Marketing source driving the traffic to the product (e.g., \"newsletter\", \"google\")."255 },256 "wishlist_id": {257 "type": "string",258 "description": "Unique identifier for the wishlist."259 },260 "wishlist_name": {261 "type": "string",262 "description": "Name of the wishlist."263 },264 "event_timestamp": {265 "type": "string",266 "format": "date-time",267 "description": "ISO 8601 timestamp indicating when the event occurred."268 },269 "user_id": {270 "type": "string",271 "description": "Identifier of the user performing the wishlist add action. Use `null` if the user is anonymous."272 },273 "anonymous_id": {274 "type": "string",275 "description": "Anonymous identifier assigned to the user if they are not logged in."276 }277 }278}
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": 85915 },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": false20 }21 },22 "event_id": "evt_1234567890",23 "event_name": "product_wishlist_add",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 "esp": 50.5,36 "event_type": "engagement",37 "l3_category": "Sweatshirts",38 "mrp": 150.75,39 "position": "top",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 "wishlist_id": "wishlist_12345",49 "wishlist_name": "Summer Collection"50}
Was this section helpful?
This event is triggered when a user removes a product from their wishlist within the storefront. It captures details such as wishlist name, ID, product details, and user information, providing valuable insights for tracking user engagement and preferences.
Events
click/product_wishlist_remove/engagement/v1
# This event is triggered when a user removes a product from their wishlist on the storefront. It includes detailed information about the user, the product removed, and the context in which the removal occurs.
Payload
Properties
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.
os
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 product wishlist remove event.
event_name
string
Required
Name of the event, typically "product_wishlist_remove".
version
string
Required
Version of the event schema.
wishlist_name
string
Required
Name of the wishlist from which the product was removed.
wishlist_id
string
Required
Unique identifier for the wishlist.
event_type
string
Required
Type of the event (e.g., "engagement").
Enum
product_id
integer
Required
Unique identifier for the product being removed from the wishlist.
brand
string
Required
Brand name of the product removed from the wishlist.
l3_category
string
Required
Tertiary category of the product.
mrp
number|null
Required
Maximum Retail Price of the product being removed from the wishlist.
quantity
string
Required
Quantity of the product removed from the wishlist. *(Typically "1", but can vary if applicable.)*
esp
number|null
Required
ESP-related metric associated with the wishlist remove action. *(Please provide more context if specific.)*
currency
string|null
Required
Currency code (e.g., "USD", "INR") used for the product price.
source_url
string
Required
URL from which the product was removed from the wishlist.
utm_campaign
string
Specific marketing campaign associated with the wishlist removal.
utm_medium
string
Marketing medium through which the user arrived at the product (e.g., "email", "cpc").
utm_source
string
Marketing source driving the traffic to the product (e.g., "newsletter", "google").
event_timestamp
string
| date-time
Required
ISO 8601 timestamp indicating when the event occurred.
user_id
string|null
Identifier of the user performing the wishlist remove action. Use `null` if the user is anonymous.
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
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 "wishlist_name",10 "wishlist_id",11 "event_type",12 "product_id",13 "brand",14 "l3_category",15 "mrp",16 "quantity",17 "esp",18 "currency",19 "source_url",20 "company_id",21 "company_mode",22 "company_created_on",23 "version"24 ],25 "description": "Event emitted when a user removes a product from their wishlist on the storefront.",26 "properties": {27 "context": {28 "type": "object",29 "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.",30 "properties": {31 "library": {32 "type": "object",33 "description": "Library information which is sending the event.",34 "properties": {35 "name": {36 "type": "string",37 "description": "Name of the library sending the event.",38 "example": "flick"39 },40 "version": {41 "type": "string",42 "description": "Version of the library.",43 "example": "1.1.1"44 }45 },46 "required": [47 "name",48 "version"49 ]50 },51 "os": {52 "type": "object",53 "description": "Operating system details for the user device.",54 "properties": {55 "name": {56 "type": "string",57 "description": "OS name.",58 "example": "Mac OS"59 },60 "version": {61 "type": "string",62 "description": "OS version.",63 "example": "10.15.7"64 }65 },66 "required": [67 "name",68 "version"69 ]70 },71 "timezone": {72 "type": "string",73 "description": "User's timezone.",74 "example": "Asia/Calcutta"75 },76 "screen": {77 "type": "object",78 "description": "Screen resolution details.",79 "properties": {80 "width": {81 "type": "integer",82 "description": "Screen width in pixels.",83 "example": 151284 },85 "height": {86 "type": "integer",87 "description": "Screen height in pixels.",88 "example": 85989 }90 },91 "required": [92 "width",93 "height"94 ]95 },96 "user_agent": {97 "type": "string",98 "description": "User agent information.",99 "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"100 },101 "locale": {102 "type": "string",103 "description": "User's locale information.",104 "example": "en-GB"105 },106 "device": {107 "type": "object",108 "description": "User's device details.",109 "properties": {110 "is_mobile": {111 "type": "boolean",112 "description": "Indicates if the device is mobile or not.",113 "example": false114 }115 },116 "required": [117 "is_mobile"118 ]119 }120 },121 "required": [122 "library",123 "os",124 "timezone",125 "screen",126 "user_agent",127 "locale",128 "device"129 ]130 },131 "event_id": {132 "type": "string",133 "description": "Unique identifier for the product wishlist remove event."134 },135 "event_name": {136 "type": "string",137 "description": "Name of the event, typically \"product_wishlist_remove\"."138 },139 "version": {140 "type": "string",141 "description": "Version of the event schema."142 },143 "wishlist_name": {144 "type": "string",145 "description": "Name of the wishlist from which the product was removed."146 },147 "wishlist_id": {148 "type": "string",149 "description": "Unique identifier for the wishlist."150 },151 "event_type": {152 "type": "string",153 "description": "Type of the event (e.g., \"engagement\").",154 "enum": [155 "engagement",156 "click",157 "conversion",158 "impression",159 "search",160 "identity"161 ]162 },163 "product_id": {164 "type": "integer",165 "description": "Unique identifier for the product being removed from the wishlist."166 },167 "brand": {168 "type": "string",169 "description": "Brand name of the product removed from the wishlist."170 },171 "l3_category": {172 "type": "string",173 "x-not-enum": true,174 "description": "Tertiary category of the product."175 },176 "mrp": {177 "type": [178 "number",179 "null"180 ],181 "description": "Maximum Retail Price of the product being removed from the wishlist."182 },183 "quantity": {184 "type": "string",185 "description": "Quantity of the product removed from the wishlist. *(Typically \"1\", but can vary if applicable.)*"186 },187 "esp": {188 "type": [189 "number",190 "null"191 ],192 "description": "ESP-related metric associated with the wishlist remove action. *(Please provide more context if specific.)*"193 },194 "currency": {195 "type": [196 "string",197 "null"198 ],199 "description": "Currency code (e.g., \"USD\", \"INR\") used for the product price."200 },201 "source_url": {202 "type": "string",203 "description": "URL from which the product was removed from the wishlist."204 },205 "utm_campaign": {206 "type": "string",207 "description": "Specific marketing campaign associated with the wishlist removal."208 },209 "utm_medium": {210 "type": "string",211 "description": "Marketing medium through which the user arrived at the product (e.g., \"email\", \"cpc\")."212 },213 "utm_source": {214 "type": "string",215 "description": "Marketing source driving the traffic to the product (e.g., \"newsletter\", \"google\")."216 },217 "event_timestamp": {218 "type": "string",219 "format": "date-time",220 "description": "ISO 8601 timestamp indicating when the event occurred."221 },222 "user_id": {223 "type": [224 "string",225 "null"226 ],227 "description": "Identifier of the user performing the wishlist remove action. Use `null` if the user is anonymous."228 },229 "company_created_on": {230 "type": "string",231 "format": "date-time",232 "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"233 },234 "company_id": {235 "type": "integer",236 "description": "Unique identifier for the company associated with the event."237 },238 "company_mode": {239 "type": "string",240 "description": "Mode of the company (e.g., \"live\", \"development\").",241 "enum": [242 "live",243 "development"244 ]245 },246 "anonymous_id": {247 "type": "string",248 "description": "Anonymous identifier assigned to the user if they are not logged in."249 }250 }251}
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": 85915 },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": false20 }21 },22 "event_id": "evt_1234567890",23 "event_name": "product_wishlist_remove",24 "version": "1",25 "event_timestamp": "2025-01-31T12:34:56Z",26 "anonymous_id": "791392dc-e279-43f9-914c-e8a42a9ee421",27 "wishlist_name": "Summer Collection",28 "wishlist_id": "wishlist_12345",29 "event_type": "engagement",30 "product_id": 7818334,31 "brand": "Armani Exchange",32 "l3_category": "Sweatshirts",33 "mrp": 150.75,34 "quantity": "1",35 "esp": 50.5,36 "currency": "INR",37 "source_url": "https://www.example.com/product/7818334",38 "utm_campaign": "similar_products",39 "utm_medium": "product_recommendation",40 "utm_source": "product_page",41 "company_created_on": "2020-05-20T08:30:00Z",42 "company_id": 123456,43 "company_mode": "live",44 "user_id": "user_12345"45}
Was this section helpful?
This event is triggered when a user removes a product from their shopping cart within the storefront. It captures details such as cart ID, product details, price, and user information, providing insights into user behavior and cart management.
Events
click/remove_from_cart/engagement/v1
# This event is triggered when a user removes a product from their shopping cart within the storefront.
Payload
Properties
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.
os
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 event.
event_name
string
Required
Name of the event.
brand
string
Required
Brand name of the product.
cart_id
string
Required
Unique identifier for the shopping cart.
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.
company_mode
string
Required
Mode of the company (e.g., "live", "development").
Enum
currency
string
Required
Currency used for the product price.
event_type
string
Required
Type of the event (e.g., "engagement").
Enum
l1_category
string
Required
Category level 1 of the product.
l3_category
string
Required
Category level 3 of the product.
price
number
Required
Price of the product in the specified currency.
product_id
integer
Required
Unique identifier for the product being removed from the cart.
quantity
integer
Required
Quantity of the product removed from the cart.
source_url
string
Required
URL source of the product.
version
string
Required
Version of the event.
user_id
string|null
Identifier of the user performing the remove from 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 "brand",10 "cart_id",11 "company_created_on",12 "company_id",13 "company_mode",14 "currency",15 "event_type",16 "l1_category",17 "l3_category",18 "price",19 "product_id",20 "quantity",21 "source_url",22 "version"23 ],24 "description": "Event emitted when a user removes an item from the cart.",25 "properties": {26 "context": {27 "type": "object",28 "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.",29 "properties": {30 "library": {31 "type": "object",32 "description": "Library information which is sending the event.",33 "properties": {34 "name": {35 "type": "string",36 "description": "Name of the library sending the event.",37 "example": "flick"38 },39 "version": {40 "type": "string",41 "description": "Version of the library.",42 "example": "1.1.1"43 }44 },45 "required": [46 "name",47 "version"48 ]49 },50 "os": {51 "type": "object",52 "description": "Operating system details for the user device.",53 "properties": {54 "name": {55 "type": "string",56 "description": "OS name.",57 "example": "Mac OS"58 },59 "version": {60 "type": "string",61 "description": "OS version.",62 "example": "10.15.7"63 }64 },65 "required": [66 "name",67 "version"68 ]69 },70 "timezone": {71 "type": "string",72 "description": "User's timezone.",73 "example": "Asia/Calcutta"74 },75 "screen": {76 "type": "object",77 "description": "Screen resolution details.",78 "properties": {79 "width": {80 "type": "integer",81 "description": "Screen width in pixels.",82 "example": 151283 },84 "height": {85 "type": "integer",86 "description": "Screen height in pixels.",87 "example": 85988 }89 },90 "required": [91 "width",92 "height"93 ]94 },95 "user_agent": {96 "type": "string",97 "description": "User agent information.",98 "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"99 },100 "locale": {101 "type": "string",102 "description": "User's locale information.",103 "example": "en-GB"104 },105 "device": {106 "type": "object",107 "description": "User's device details.",108 "properties": {109 "is_mobile": {110 "type": "boolean",111 "description": "Indicates if the device is mobile or not.",112 "example": false113 }114 },115 "required": [116 "is_mobile"117 ]118 }119 },120 "required": [121 "library",122 "os",123 "timezone",124 "screen",125 "user_agent",126 "locale",127 "device"128 ]129 },130 "event_id": {131 "type": "string",132 "description": "Unique identifier for the event."133 },134 "event_name": {135 "type": "string",136 "description": "Name of the event."137 },138 "brand": {139 "type": "string",140 "description": "Brand name of the product."141 },142 "cart_id": {143 "type": "string",144 "description": "Unique identifier for the shopping cart."145 },146 "company_created_on": {147 "type": "string",148 "format": "date-time",149 "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"150 },151 "company_id": {152 "type": "integer",153 "description": "Unique identifier for the company."154 },155 "company_mode": {156 "type": "string",157 "description": "Mode of the company (e.g., \"live\", \"development\").",158 "enum": [159 "live",160 "development"161 ]162 },163 "currency": {164 "type": "string",165 "description": "Currency used for the product price."166 },167 "event_type": {168 "type": "string",169 "description": "Type of the event (e.g., \"engagement\").",170 "enum": [171 "engagement",172 "click",173 "conversion",174 "impression",175 "search",176 "identity"177 ]178 },179 "l1_category": {180 "type": "string",181 "x-not-enum": true,182 "description": "Category level 1 of the product."183 },184 "l3_category": {185 "type": "string",186 "x-not-enum": true,187 "description": "Category level 3 of the product."188 },189 "price": {190 "type": "number",191 "description": "Price of the product in the specified currency."192 },193 "product_id": {194 "type": "integer",195 "description": "Unique identifier for the product being removed from the cart."196 },197 "quantity": {198 "type": "integer",199 "description": "Quantity of the product removed from the cart."200 },201 "source_url": {202 "type": "string",203 "description": "URL source of the product."204 },205 "version": {206 "type": "string",207 "description": "Version of the event."208 },209 "user_id": {210 "type": [211 "string",212 "null"213 ],214 "description": "Identifier of the user performing the remove from cart action. Use `null` if the user is anonymous."215 },216 "anonymous_id": {217 "type": "string",218 "description": "Anonymous identifier assigned to the user if they are not logged in."219 }220 }221}
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": 85915 },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": false20 }21 },22 "event_id": "evt_9876543210",23 "event_name": "remove_from_cart",24 "event_timestamp": "2025-01-31T12:34:56Z",25 "anonymous_id": "791392dc-e279-43f9-914c-e8a42a9ee421",26 "brand": "Armani Exchange",27 "cart_id": "664c6d8f9279128152fb551b",28 "company_created_on": "2020-05-20T08:30:00Z",29 "company_id": 123456,30 "company_mode": "online",31 "currency": "INR",32 "event_type": "engagement",33 "l1_category": "Clothing",34 "l3_category": "Sweatshirts",35 "price": 100.5,36 "product_id": 7818334,37 "quantity": 1,38 "source_url": "https://www.example.com/product/7818334",39 "version": "1",40 "user_id": null41}
Was this section helpful?
This event is triggered when a user logs into the storefront. It captures details such as login method, user device, and timestamp, providing insights into user authentication and behavior.
Events
click/user_login/identity/v1
# This event is triggered when a user logs into their account on the storefront. It includes detailed information about the user and the environment from which the login occurs.
Payload
Properties
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.
os
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 event.
event_name
string
Required
Name of the event (e.g., "user_login").
version
string
Required
Version of the event schema.
event_type
string
Required
Type of the event (e.g., "engagement").
Enum
method
string
Required
Method used for login (e.g., "email", "mobile").
Enum
phone
object|string
Phone number used for login.
Properties
phone
string
Required
User's phone number.
active
boolean
Required
Indicates if the phone number is active.
primary
boolean
Required
Indicates if this is the primary phone number.
verified
boolean
Required
Indicates if the phone number is verified.
country_code
integer
Required
Country code of the phone number.
login_value
string
Required
Value used by the user for login. This could be either user's email or phone number.
company_id
integer
Required
ID of the company.
company_mode
string
Required
Mode of the company (e.g., "live", "development").
Enum
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.
event_timestamp
string
| date-time
Required
Timestamp of the event.
user_id
string|null
Identifier of the user performing the user login 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 "event_type",10 "company_id",11 "company_mode",12 "company_created_on",13 "version",14 "method",15 "login_value"16 ],17 "description": "Event emitted when a user logs into their account on the storefront.",18 "properties": {19 "context": {20 "type": "object",21 "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.",22 "properties": {23 "library": {24 "type": "object",25 "description": "Library information which is sending the event.",26 "properties": {27 "name": {28 "type": "string",29 "description": "Name of the library sending the event.",30 "example": "flick"31 },32 "version": {33 "type": "string",34 "description": "Version of the library.",35 "example": "1.1.1"36 }37 },38 "required": [39 "name",40 "version"41 ]42 },43 "os": {44 "type": "object",45 "description": "Operating system details for the user device.",46 "properties": {47 "name": {48 "type": "string",49 "description": "OS name.",50 "example": "Mac OS"51 },52 "version": {53 "type": "string",54 "description": "OS version.",55 "example": "10.15.7"56 }57 },58 "required": [59 "name",60 "version"61 ]62 },63 "timezone": {64 "type": "string",65 "description": "User's timezone.",66 "example": "Asia/Calcutta"67 },68 "screen": {69 "type": "object",70 "description": "Screen resolution details.",71 "properties": {72 "width": {73 "type": "integer",74 "description": "Screen width in pixels.",75 "example": 151276 },77 "height": {78 "type": "integer",79 "description": "Screen height in pixels.",80 "example": 85981 }82 },83 "required": [84 "width",85 "height"86 ]87 },88 "user_agent": {89 "type": "string",90 "description": "User agent information.",91 "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"92 },93 "locale": {94 "type": "string",95 "description": "User's locale information.",96 "example": "en-GB"97 },98 "device": {99 "type": "object",100 "description": "User's device details.",101 "properties": {102 "is_mobile": {103 "type": "boolean",104 "description": "Indicates if the device is mobile or not.",105 "example": false106 }107 },108 "required": [109 "is_mobile"110 ]111 }112 },113 "required": [114 "library",115 "os",116 "timezone",117 "screen",118 "user_agent",119 "locale",120 "device"121 ]122 },123 "event_id": {124 "type": "string",125 "description": "Unique identifier for the event."126 },127 "event_name": {128 "type": "string",129 "description": "Name of the event (e.g., \"user_login\")."130 },131 "version": {132 "type": "string",133 "description": "Version of the event schema."134 },135 "event_type": {136 "type": "string",137 "description": "Type of the event (e.g., \"engagement\").",138 "enum": [139 "engagement",140 "click",141 "conversion",142 "impression",143 "search",144 "identity"145 ]146 },147 "method": {148 "type": "string",149 "description": "Method used for login (e.g., \"email\", \"mobile\").",150 "enum": [151 "email",152 "mobile"153 ]154 },155 "phone": {156 "type": [157 "object",158 "string"159 ],160 "description": "Phone number used for login.",161 "properties": {162 "phone": {163 "type": "string",164 "description": "User's phone number."165 },166 "active": {167 "type": "boolean",168 "description": "Indicates if the phone number is active."169 },170 "primary": {171 "type": "boolean",172 "description": "Indicates if this is the primary phone number."173 },174 "verified": {175 "type": "boolean",176 "description": "Indicates if the phone number is verified."177 },178 "country_code": {179 "type": "integer",180 "description": "Country code of the phone number."181 }182 },183 "required": [184 "phone",185 "active",186 "primary",187 "verified",188 "country_code"189 ]190 },191 "login_value": {192 "type": "string",193 "description": "Value used by the user for login. This could be either user's email or phone number."194 },195 "company_id": {196 "type": "integer",197 "description": "ID of the company."198 },199 "company_mode": {200 "type": "string",201 "description": "Mode of the company (e.g., \"live\", \"development\").",202 "enum": [203 "live",204 "development"205 ]206 },207 "company_created_on": {208 "type": "string",209 "format": "date-time",210 "description": "Timestamp or detailed information indicating when the company was created. Can be an ISO 8601 string or a complex object with additional details."211 },212 "event_timestamp": {213 "type": "string",214 "format": "date-time",215 "description": "Timestamp of the event."216 },217 "user_id": {218 "type": [219 "string",220 "null"221 ],222 "description": "Identifier of the user performing the user login action. Use `null` if the user is anonymous."223 },224 "anonymous_id": {225 "type": "string",226 "description": "Anonymous identifier assigned to the user if they are not logged in."227 }228 }229}
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": 85915 },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": false20 }21 },22 "event_id": "evt_1234567890",23 "event_name": "user_login",24 "version": "1",25 "event_timestamp": "2025-01-31T12:34:56Z",26 "anonymous_id": "791392dc-e279-43f9-914c-e8a42a9ee421",27 "event_type": "identity",28 "phone": {29 "phone": "8888888888",30 "active": true,31 "primary": true,32 "verified": true,33 "country_code": 134 },35 "company_id": 123456,36 "company_mode": "live",37 "company_created_on": "2020-05-20T08:30:00Z",38 "method": "password",39 "login_value": "success",40 "user_id": "user_12345"41}
Was this section helpful?
This event is triggered when a user logs out of the storefront. It provides insights into user session management and behavior.
Events
click/user_logout/identity/v1
# This event is triggered when a user logs out of their account on the storefront. It includes detailed information about the user and the environment from which the logout occurs.
Payload
Properties
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.
os
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 event.
event_name
string
Required
Name of the event, typically "user_logout".
version
string
Required
Version of the event schema.
event_type
string
Required
Type of the event (e.g., "engagement").
Enum
company_id
integer
Required
ID of the company.
company_mode
string
Required
Mode of the company (e.g., "live", "development").
Enum
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.
event_timestamp
string
| date-time
Required
Timestamp of the event.
user_id
string
Required
Identifier of the user performing the user logout action.
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 "user_id",9 "anonymous_id",10 "event_type",11 "company_id",12 "company_mode",13 "company_created_on",14 "version"15 ],16 "description": "Event emitted when a user logs out of their account on the storefront.",17 "properties": {18 "context": {19 "type": "object",20 "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.",21 "properties": {22 "library": {23 "type": "object",24 "description": "Library information which is sending the event.",25 "properties": {26 "name": {27 "type": "string",28 "description": "Name of the library sending the event.",29 "example": "flick"30 },31 "version": {32 "type": "string",33 "description": "Version of the library.",34 "example": "1.1.1"35 }36 },37 "required": [38 "name",39 "version"40 ]41 },42 "os": {43 "type": "object",44 "description": "Operating system details for the user device.",45 "properties": {46 "name": {47 "type": "string",48 "description": "OS name.",49 "example": "Mac OS"50 },51 "version": {52 "type": "string",53 "description": "OS version.",54 "example": "10.15.7"55 }56 },57 "required": [58 "name",59 "version"60 ]61 },62 "timezone": {63 "type": "string",64 "description": "User's timezone.",65 "example": "Asia/Calcutta"66 },67 "screen": {68 "type": "object",69 "description": "Screen resolution details.",70 "properties": {71 "width": {72 "type": "integer",73 "description": "Screen width in pixels.",74 "example": 151275 },76 "height": {77 "type": "integer",78 "description": "Screen height in pixels.",79 "example": 85980 }81 },82 "required": [83 "width",84 "height"85 ]86 },87 "user_agent": {88 "type": "string",89 "description": "User agent information.",90 "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"91 },92 "locale": {93 "type": "string",94 "description": "User's locale information.",95 "example": "en-GB"96 },97 "device": {98 "type": "object",99 "description": "User's device details.",100 "properties": {101 "is_mobile": {102 "type": "boolean",103 "description": "Indicates if the device is mobile or not.",104 "example": false105 }106 },107 "required": [108 "is_mobile"109 ]110 }111 },112 "required": [113 "library",114 "os",115 "timezone",116 "screen",117 "user_agent",118 "locale",119 "device"120 ]121 },122 "event_id": {123 "type": "string",124 "description": "Unique identifier for the event."125 },126 "event_name": {127 "type": "string",128 "description": "Name of the event, typically \"user_logout\"."129 },130 "version": {131 "type": "string",132 "description": "Version of the event schema."133 },134 "event_type": {135 "type": "string",136 "description": "Type of the event (e.g., \"engagement\").",137 "enum": [138 "engagement",139 "click",140 "conversion",141 "impression",142 "search",143 "identity"144 ]145 },146 "company_id": {147 "type": "integer",148 "description": "ID of the company."149 },150 "company_mode": {151 "type": "string",152 "description": "Mode of the company (e.g., \"live\", \"development\").",153 "enum": [154 "live",155 "development"156 ]157 },158 "company_created_on": {159 "type": "string",160 "format": "date-time",161 "description": "Timestamp or detailed information indicating when the company was created. Can be an ISO 8601 string or a complex object with additional details."162 },163 "event_timestamp": {164 "type": "string",165 "format": "date-time",166 "description": "Timestamp of the event."167 },168 "user_id": {169 "type": "string",170 "description": "Identifier of the user performing the user logout action."171 },172 "anonymous_id": {173 "type": "string",174 "description": "Anonymous identifier assigned to the user if they are not logged in."175 }176 }177}
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": 85915 },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": false20 }21 },22 "event_id": "evt_1234567890",23 "event_name": "user_logout",24 "version": "1",25 "event_timestamp": "2025-01-31T12:34:56Z",26 "anonymous_id": "791392dc-e279-43f9-914c-e8a42a9ee421",27 "event_type": "authentication",28 "company_id": 123456,29 "company_mode": "live",30 "company_created_on": "2020-05-20T08:30:00Z",31 "user_id": "user_12345"32}
Was this section helpful?