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.

Product price

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.

Product price/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

Event emitted when a user checks any pincode for servicability.

context

object

Required

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

Properties

library

object

Required

Library information which is sending the event.

Properties

name

string

Required

Name of the library sending the event.

version

string

Required

Version of the library.

object

Required

Operating system details for the user device.

Properties

name

string

Required

OS name.

version

string

Required

OS version.

timezone

string

Required

User's timezone.

screen

object

Required

Screen resolution details.

Properties

width

integer

Required

Screen width in pixels.

height

integer

Required

Screen height in pixels.

user_agent

string

Required

User agent information.

locale

string

Required

User's locale information.

device

object

Required

User's device details.

Properties

is_mobile

boolean

Required

Indicates if the device is mobile or not.

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": 1512
78            },
79            "height": {
80              "type": "integer",
81              "description": "Screen height in pixels.",
82              "example": 859
83            }
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": false
108            }
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": 859
15    },
16    "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/122.0.0.0 Safari/537.36",
17    "locale": "en-GB",
18    "device": {
19      "is_mobile": false
20    }
21  },
22  "event_id": "evt_1234567890",
23  "event_name": "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}

« product_listing/conversion/v1

product_search/search/v1 »