Event API Integration

How to send in-app/ in-web/ in-ad events to Kayzen platform

Overview

Kayzen platform has a robust event and audience API. Advertisers can send specific events directly to Kayzen and use the powerful and flexible audience segmentation feature to create and target different user cohorts

Base URL
ā€‹
https://api-events.eventstracker.io/v1/ev?

Query Parameters
tp=direct&api_key={api_key}&idfa={IDFA}&gaid={GAID}&os={OS}&activity_kind={activity_kind}&package_name={app_package_name}&app_event={app_event}&event_items={event_items_JSON}&can_claim={0/1}&view_through={0/1}&bid_id={CLICK_ID}&ip=&country_code=&city=&is_reengagement={0/1}&revenue_USD={revenue_in_usd}&idfv={idfv}&event_ts={event_ts}c0=&c1=&c2=

ParametersRequiredDescription
api_keyYesUnique api key for your account/ app/website. You can get this api_key from Kayzen UI
idfaPreferrediOS unique IDFA
gaidPreferredGoogle unique advertising ID
idfvPreferrediOS unique identifier by a publisher
osPreferredandroid/IOS
activity_kindNoType of event. For eg; event, install, impression
package_nameNoAndroid app bundle name/ IOS app store ID
app_eventYesName of the event that you have recorded. eg: app_open, registration, purchase etc.
event_itemsNoFor any event, you can pass multiple event in a JSON format. Eg: in case of purchase of an item, you can pass attribute like price, product_id, colour, currency etc. Nested JSON must be URL encoded string of array of JSON. For multiple attributes JSON is preferred. For single attribute this can be string as well.

event_items JSON should be encoded (ref eg below)
can_claimYes0 (default attribute)- Unattributed event
1- attributed event.
view_throughNo0 (default value)- click based attribution
1- Impression based attribution
bid_idYesPass through parameter. Pass the click_id that was recorded when the user clicked on ad.
is_reengagementNo0-it's not a re-engagement event
1- it's a re-engagement event
event_tsPreferredTimestamp the event occurred.
revenue_USDNoRevenue generated in USD from an event for eg. a purchase event.
If revenue is generated in other currency, use below 2 fields instead.
revenueNoRevenue generated from an event for eg. a purchase event
currencyNoCurrency in ISO - 4217 format
c0,c1,c2NoGeneric pass through variables. Use these parameters for passing value of custom value.

Sample API End Point

https://api-events.eventstracker.io/v1/ev?tp=direct&api_key=f8f2036f1704d106dc916f692826b497686a03e5&idfa=D3F15CAE-B2DB-4FZD-9B34-X78C88C81538&gaid=&os=ios&activity_kind=event&package_name=com.app.package&app_event=purchase&can_claim=1&view_through=0&bid_id=892501088-1552511436&ip=172.58.104.88&country_code=US&city=Dallas&is_reengagement=1&c0=&c1=&c2=&event_items=%5B%7B%22currency%22%3A%22USD%22%2C%20%22revenue%22%3A%200.02190650151%7D%5D