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=
Parameters | Required | Description |
---|---|---|
api_key | Yes | Unique api key for your account/ app/website. You can get this api_key from Kayzen UI |
idfa | Preferred | iOS unique IDFA |
gaid | Preferred | Google unique advertising ID |
idfv | Preferred | iOS unique identifier by a publisher |
os | Preferred | android/IOS |
activity_kind | No | Type of event. For eg; event, install, impression |
package_name | No | Android app bundle name/ IOS app store ID |
app_event | Yes | Name of the event that you have recorded. eg: app_open, registration, purchase etc. |
event_items | No | For 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_claim | Yes | 0 (default attribute)- Unattributed event 1- attributed event. |
view_through | No | 0 (default value)- click based attribution 1- Impression based attribution |
bid_id | Yes | Pass through parameter. Pass the click_id that was recorded when the user clicked on ad. |
is_reengagement | No | 0-it's not a re-engagement event 1- it's a re-engagement event |
event_ts | Preferred | Timestamp the event occurred. |
revenue_USD | No | Revenue generated in USD from an event for eg. a purchase event. If revenue is generated in other currency, use below 2 fields instead. |
revenue | No | Revenue generated from an event for eg. a purchase event |
currency | No | Currency in ISO - 4217 format |
c0,c1,c2 | No | Generic pass through variables. Use these parameters for passing value of custom value. |
Sample API End Point