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 listing

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.

Product Listing/product_listing/conversion/v1

This event is emitted when a user visits the product listing.

Payload

Properties

Event emitted when a user views product listing on the storefront.

context

object

Required

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

Properties

library

object

Required

Library information which is sending the event.

Properties

name

string

Required

Name of the library sending the event.

version

string

Required

Version of the library.

object

Required

Operating system details for the user device.

Properties

name

string

Required

OS name.

version

string

Required

OS version.

timezone

string

Required

User's timezone.

screen

object

Required

Screen resolution details.

Properties

width

integer

Required

Screen width in pixels.

height

integer

Required

Screen height in pixels.

user_agent

string

Required

User agent information.

locale

string

Required

User's locale information.

device

object

Required

User's device details.

Properties

is_mobile

boolean

Required

Indicates if the device is mobile or not.

event_id

string

Required

Unique identifier for the 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": 1512
77            },
78            "height": {
79              "type": "integer",
80              "description": "Screen height in pixels.",
81              "example": 859
82            }
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": false
107            }
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": 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_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": null
55}

« order_complete/conversion/v1

product_price/click/v1 »