Wishi partner widget/SDK documentation
  • The Formal Stuff
    • Introduction
    • iOS SDK
      • Setup
        • View controller setup example
      • Public protocols
      • Public API's
      • Data structures/types
    • Web SDK
      • Setup
      • Initialization
      • Data structures
      • Public API's/interfaces
      • Events subscription
      • Telemetry
    • Pixel
      • Set up the base code
      • Set up events
      • Tracking parameters
    • Client-side authentication
    • FAQ
Powered by GitBook
On this page
  • Events
  • Event Data Structure
  • Event Object
  • Product Object

Was this helpful?

  1. The Formal Stuff
  2. Pixel

Tracking parameters

Events

Following events are supported:

  1. ProductViewed - tracked when dedicated product page (PDP) was viewed

  2. ProductAddedToCart - tracked when product added to shopping cart

  3. CheckoutCompleted - tracked when checkout completed successfully

Event Data Structure

Data structure is the same for all three events and should include at least one product:

{
  partnerUserId: "123-123",
  products: [
    {
      id: "1",
      name: "Name",
      buyUrl: "https://...",
      imageUrl: "https: //...",
      brand: "A name",
      price: 123.99,
      currency: "USD"
    },
    {
      id: "2",
      name: "Another Name",
      buyUrl: "https://...",
      imageUrl: "https: //...",
      brand: "Brand name",
      price: 22,
      currency: "USD",
      quantity: 3
    }
  ]
}

Event Object

Property Key
Value Type
Parameter Description

partnerUserId

string

The same partner user id value that was used during Wishi SDK initialization.

products

array of objects

Array of JSON objects that contains a list of products associated with the event. All properties except quantity are required.

Product Object

All fields are required except quantity

Property Key
Value Type
Parameter Description

id

string

Product SKU. If other type of ID is used, please contact support before setting up the pixel.

name

string

Product name

buyUrl

url

PDP or other buy URL

imageUrl

url

Product image url

brand

string

Product brand name

price

integer, float

Full product price

currency

string

Currency for the price specified.

quantity

integer

Number of products, default 1

PreviousSet up eventsNextClient-side authentication

Last updated 1 year ago

Was this helpful?