Supported Parameters

Kayzen reporting API allows you to create, update, view and delete your campaign's performance reports

Supported metrics, filters and group_by parameters are listed below

Metrics

Metrics

Description

wins

Total count of auctions won

impressions

Total count of ad-impressions served

clicks

Total count of clicks

conversions

Total count of conversions as defined by a conversion_object

unique_users

Total count of unique_users who did a conversion action. Defined as part of conversion_object

ct_installs

Total count of click-through attributed installs

vt_installs

Total count of view-through attributed installs

win_rate

Value between 0 - 1. Multiply by 100 to get the number in percentage. Win Rate is calculated as Wins/Bids.

ctr

Value between 0 - 1. Multiply by 100 to get the number in percentage. CTR is calculated as clicks/impressions

conversion_rate

Value between 0 - 1. Multiply by 100 to get the number in percentage. Conversion rate is calculated as installs/clicks

video_start

Total count of video start events

video_first_quartile

Total count of video first quartile events

video_midpoint

Total count of video midpoint events

video_third_quartile

Total count of video third quartile events

video_complete

Total count of video complete events

advertiser_ecpm

Effective cost per thousand impressions

advertiser_ecpc

Effective cost per click

advertiser_ecpi

Effective cost per install

advertiser_ecpa

Effective cost per Conversion action as defined by conversion object

Filters

Filters

Description

Sample/ Supported Values

tag

Array of tags created by the user.

Sample Value-
Retargeting,
UA,
Branding

line_item_id

Array of line item id's. Also represented in the UI as Orders

Sample Value- 104669

campaign_id

Array of unique campaign id's

Sample Value- 138939.
Please refer to Campaigns

deal_id

Array of unique deal id's

Sample Value- 2349

creative_id

Array of unique creative ids

Sample Value- 50279679
Please refer to Creatives

exchange_id

Array of programmatic exchange id's

Please refer to Exchanges

app_object_id

Array of unique advertiser app object id's

Sample Value - [10, 12]
Please refer to App Objects

site_object_id

Array of unique advertiser website object id's

Sample Value - [11, 13]
Please refer to Site Objects

app_id

Array of publisher app ids: Unique Kayzen specific id for every publisher app per exchange

Sample Value- 63webhaubwajhb27820

app_bundle_id

Array of publisher app bundle ids: Unique appstore/playstore bundle ID for publisher app

Sample Value- com.forthblue.pool

user_country_id

Array of country ids: Kayzen specified ID's for every country

Please refer to Countries

manufacturer_id

Array of manufacturer ids: Unique ID for device manufacturers

Please refer to Manufacturers (Device)

traffic_type

Type of traffic on which campaign served.

Supported Value-
InAPP,
MobileWeb,
Unknown

connection_type

Type of user connection.

Supported Values-
Carrier Network,
Wifi

Group By

Field

Description

Sample/ Supported Values

year

calendar year

Sample Value- 2019

month

calendar month

Supported Values- 1, 2,12

day

calendar date

Sample Value- 21 March 2019

line_item_name

Name of line items. Line items are represented as Orders in the UI

Sample Value- Test Order

line_item_id

ID of line items. Line items are represented as Orders in the UI

Sample Value- 104669

campaign_name

Name of the campaigns

Sample Value- Test Campaign

campaign_id

Unique ID of the campaign

Sample Value- 138939

dealid

Unique PMP deal id's

Sample Value- 2349

campaign_type

Optimization algorithm that the campaign is using.

Supported Values-
CPM,
CPC,
CPI

creative_name

Creative name in the platform

Sample Value- Test Creative

creative_id

Unique ID per creative

Sample Value- 50279679

creative_type

Type/format of creative

Supported Values-
Image,
HTML,
Native
Video

is_ssl

Specify whether creative's click and impression URL were secure url's or not

Supported Values-
0 - Non Secure
1- Secure

video_duration

Length of video file. Example: 15sec, 30sec, 45sec

Sample Value- 15, 29, 30

video_resume

Total count of video resume events

Sample Value- 139282

exchange_name

Name of programmatic exchanges integrated with Kayzen Platform

Please refer to Exchanges

exchange_id

Unique ID for programmatic exchanges on Kayzen platform

Please refer to Exchanges

app_name

Exchange specific publisher app name. Same app might have different names across exchanges

Sample Value- Pool Billiards Pro

app_id

Exchange specific Unique ID for publisher apps. Same app will have different app_id across exchanges

Sample Value- 3b01c74ab91c8f7f78caae7c38428434

app_bundle_id

Playstore/App store bundle id/app id for the publisher app

com.king.candycrushsaga

app_object_name

Advertiser app name in Playstore / AppStore

Sample Value -
Angry Birds 2

site_object_name

Advertiser site URL

Sample Value -
https://www.amazon.com/

app_object_store_id

Package Name / App ID of the Google / Apple Play Store Apps accessible to the advertiser.

Sample Value -
880047117
com.rovio.baba

user_country_id

List of Kayzen specific Country ID's

Please refer to Countries

country

List of Country names

Please refer to Countries

country_code

Alpha-3 digit ISO country code for every country

Sample Value- RUS for Russia

traffic_type

Type of traffic on which campaign served

Supported Value-
InAPP
MobileWeb
Unknown

os_name

Name of the user's device operating system

Please refer to OS- Operating System

os_version_name

Operating system version of user's device

Please refer to OS Version

manufacturer_name

Device's manufacturer name

Please refer to Manufacturers (Device)

manufacturer_id

Kayzen specific unique ID of device manufacturers

Please refer to Manufacturers (Device)

connection_type

Type of user connection

Supported Values-
Carrier Network ,
Wifi

advertiser_name

Advertiser name in Kayzen Platform

Sample Value- Test Advertiser

advertiser_id

Advertiser ID in Kayzen Platform

Sample Value- 12274


What’s Next

Learn how to create new report through Kayzen API