Triggering Widget Pixels - iOS
Make sure you have completed the steps mentioned in the main iOS Application Pixel Integration guide before going through this page.
The Widget pixels are needed when you have a Recommendations widget on the screen. The code for the individual Widget pixels should be added where the Widget is being loaded.
Widget View Pixel
PixelTracker.shared.widgetView(
widgetDataWrId: "abcd123",
widgetViewDataWq: "black dress",
widgetViewDataWid: "abc123",
widgetViewDataWty: "mlt"
)
Here is a list of the different parameters you can use to configure the pixel:
| Parameter | Description |
|---|---|
| widgetDataWrId | The unique ID of the response. This value has to be populated from the Recommendations and Pathways API response’s metadata.widget.rid |
| widgetViewDataWq | The query string used by the customer, which returns a widget suggestion. This is optional for non-query widgets |
| widgetViewDataWid | The widget ID. This is a unique, 6 character alphanumeric value. This value has to be populated from the Recommendations and Pathways API response’s metadata.widget.id |
| widgetViewDataWty | The type of recommendation widget. This value has to be populated from the Recommendations and Pathways API response’s metadata.widget.type |
Widget Click Pixel
PixelTracker.shared.widgetClick(
widgetDataWrId: "abcd123",
widgetViewDataWq: "black dress",
widgetViewDataWid: "abc123",
widgetViewDataWty: "mlt",
widgetDataItemId: "pd123"
)
Here is a list of the different parameters you can use to configure the pixel:
| Parameter | Description |
|---|---|
| widgetDataWrId | The unique ID of the response. This value has to be populated from the Recommendations and Pathways API response’s metadata.widget.rid |
| widgetViewDataWq | The query string used by the customer which returns a widget suggestion. This is optional for non-query widgets |
| widgetViewDataWid | The widget ID. This is a unique, 6 character alphanumeric value. This value has to be populated from the Recommendations and Pathways API response’s metadata.widget.id |
| widgetViewDataWty | The type of recommendation widget. This value has to be populated from the API response. This value has to be populated from the Recommendations and Pathways API response’s metadata.widget.type |
| widgetDataItemId | The unique ID (PID) of the clicked product |
Widget Add To Cart Pixel
PixelTracker.shared.widgetAddToCart(
widgetDataWrId: "abcd123",
widgetViewDataWq: "black dress",
widgetViewDataWid: "abc123",
widgetViewDataWty: "mlt",
widgetDataItemId: "id123",
widgetAtcDataSku: "id123"
)
Here is a list of the different parameters you can use to configure the pixel:
| Parameter | Description |
|---|---|
| widgetDataWrId | The unique ID of the response. This value has to be populated from the Recommendations and Pathways API response’s metadata.widget.rid |
| widgetViewDataWq | The query string used by the customer, which returns a widget suggestion. This is optional for non-query widgets |
| widgetViewDataWid | The widget ID. This is a unique, 6 character alphanumeric value. This value has to be populated from the Recommendations and Pathways API response’s metadata.widget.id |
| widgetViewDataWty | The type of recommendation widget. This value has to be populated from the API response. This value has to be populated from the Recommendations and Pathways API response’s metadata.widget.type |
| widgetDataItemId | The unique ID (PID) of the clicked product |
| widgetAtcDataSku | Unique SKU ID that represents the selected variant of this product (e.g. size M, color blue of a t-shirt). If your app does not have SKUs, leave this blank |
Updated 5 months ago