Getting Started

Conversion Events

The Koah Pixel and Conversion API support multiple conversion event types to help you track and measure specific user actions on your website.

Best Practices

  1. Be Consistent: Use the same event names and parameters across your website
  2. Include Value: Always include monetary value for purchase-related events
  3. Test Events: Verify events are firing correctly in your dashboard before launching campaigns
  4. Avoid Duplicates: Ensure events are not fired multiple times for the same action
  5. Value Requirements: When including a value parameter, it must be greater than 0
  6. String Length: Product id, name, and category values may be truncated if they are too long (over 100 characters for id and category, or over 255 characters for name)

Event IDs

In addition to the event-specific parameters described below, each event supports an eventId parameter (eventId for pixel events, event_id for CAPI events) uniquely identifying this event. This can be any string: a transaction ID, randomly generated, etc. If it is longer than 512 characters, it will be truncated to the first 512. This can be used for several purposes:

  • Idempotency: if events with the same eventId are sent multiple times, Koah can detect the duplicates and consolidate to 1 event in our event count metrics.
  • Debugging: you can set a specific eventId on a test event to easily identify it among a stream of other events.
  • Deduplication with conversion API: if you've integrated both the pixel and API, you must use the same eventId / event_id for each event that both sources report. See de-duplicating events for details and example code.

An example implementation using randomly generated event IDs is below:

kad('track', 'PageView', {
  'eventId': crypto.randomUUID()
});

Targeting Specific Advertisers

If you've set up multiple advertisers on the same website, then all events will be tracked to all initialized advertisers by default. In order to track events with only specific advertiser(s), use the advertiserIds parameter to track. For example:

kad('track', 'Purchase', {
  currency: 'USD',
  value: 99.99,
  products: [
    { id: '1234', name: 'Product A', category: 'Electronics' },
    { id: '5678', name: 'Product B', category: 'Electronics' },
  ],
  itemCount: 2,
  advertiserIds: ['ADVERTISER_ID_1']
})

Each entry passed to advertiserIds must have been initialized in kad("init").

Supported Events

EventDescription
Page ViewA person lands on a page. It lets you know they visited the web page's URL but doesn't tell you what they did or saw.
View ContentA person lands on a specific webpage, like a product page, or views a particular piece of content.
SearchA person submits a search query on your website.
Add To CartA person adds an item to their shopping cart.
Add To WishlistA person adds an item to their wishlist.
Initiate CheckoutA person starts checkout before purchase.
PurchaseA person completes a purchase.
LeadA person submits information expressing interest in an advertised product.
Sign UpA person submits a form, like a subscription, registration, or sign-up form.

Page View

A person lands on a page. This event is automatically tracked when the Koah Pixel loads.

No available parameters

View Content

A person lands on a specific webpage, like a product page, or views a particular piece of content.

ParameterTypeDescription
currencystring (optional)The currency for the value based on three letter ISO 4217 codes
valuenumber (optional)The monetary value of a user for the conversion event
productsArray<Object> (optional)Array of product objects with required id and optional name and category fields. All values are strings.

A person submits a search query on your website.

ParameterTypeDescription
currencystring (optional)The currency for the value based on three letter ISO 4217 codes
valuenumber (optional)The monetary value of a user for the conversion event
productsArray<Object> (optional)Array of product objects with required id and optional name and category fields. All values are strings.

Add To Cart

A person adds an item to their shopping cart.

ParameterTypeDescription
currencystring (optional)The currency for the value based on three letter ISO 4217 codes
valuenumber (optional)The monetary value of a user for the conversion event
productsArray<Object> (optional)Array of product objects with required id and optional name and category fields. All values are strings.
itemCountnumber (optional)The number of items for the conversion event

Add To Wishlist

A person adds an item to their wishlist.

ParameterTypeDescription
currencystring (optional)The currency for the value based on three letter ISO 4217 codes
valuenumber (optional)The monetary value of a user for the conversion event
productsArray<Object> (optional)Array of product objects with required id and optional name and category fields. All values are strings.
itemCountnumber (optional)The number of items for the conversion event

Initiate Checkout

A person starts checkout before purchase.

ParameterTypeDescription
currencystring (optional)The currency for the value based on three letter ISO 4217 codes
valuenumber (optional)The monetary value of a user for the conversion event
productsArray<Object> (optional)Array of product objects with required id and optional name and category fields. All values are strings.
itemCountnumber (optional)The number of items for the conversion event

Purchase

A person completes a purchase.

ParameterTypeDescription
currencystring (required)The currency for the value based on three letter ISO 4217 codes
valuenumber (required)The monetary value of a user for the conversion event
productsArray<Object> (optional)Array of product objects with required id and optional name and category fields. All values are strings.
itemCountnumber (optional)The number of items for the conversion event

Lead

A person submits information expressing interest in an advertised product/offer.

ParameterTypeDescription
currencystring (optional)The currency for the value based on three letter ISO 4217 codes
valuenumber (optional)The monetary value of a user for the conversion event

Sign Up

A person submits a form, like a subscription, registration, or sign-up form.

ParameterTypeDescription
currencystring (optional)The currency for the value based on three letter ISO 4217 codes
valuenumber (optional)The monetary value of a user for the conversion event
productsArray<Object> (optional)Array of product objects with required id and optional name and category fields. All values are strings.
Was this helpful?