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 remove

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.

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

Event emitted when a user removes a product from 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 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": 1512
84            },
85            "height": {
86              "type": "integer",
87              "description": "Screen height in pixels.",
88              "example": 859
89            }
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": false
114            }
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": 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_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}

« product_wishlist_add/engagement/v1

remove_from_cart/engagement/v1 »