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 wishlist add

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.

Product Wishlist Add/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

Event emitted when a user adds a product to their wishlist 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 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": 1512
89            },
90            "height": {
91              "type": "integer",
92              "description": "Screen height in pixels.",
93              "example": 859
94            }
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": false
119            }
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": 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_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}

« product_view/click/v1

product_wishlist_remove/engagement/v1 »