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_v2 | Total count of unique devices. See Unique Users in the help center |
| new_uniques | Estimated number of new unique devices calculated based on rolling 90 day window. See Unique Users in the help center |
| ct_installs (deprecated) | Total count of click-through attributed installs |
| vt_installs (deprecated) | Total count of view-through attributed installs |
| installs | Total number of installs. Value will change based on selected attribution sources (default: mmp) and attribution type(default: Total). See below for more details |
| 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 |
| ipm | Installs per Mille (1000 impressions). A measure of performance that tells the number of installs generated per 1000 impressions served |
| 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 |
| advertiser_spend | Cost incurred by advertiser |
| revenue_ltv | Total revenue generated for the advertiser |
| roi_ltv | Return on AdSpend (RoAS) = Total revenue generated / Advertiser Spend |
You can use LTV events as metric. Example of LTV event metric: ltv_u_advertiser_23456_mobobj_43_event_2240793_Install. To get a list of LTV events you need to use Allowed LTV Events API.
The unique_users_v2 metric requires:
- Group by: Day (
day), Week (week), Month (month) and OS (os_name) - Filter by: a single selection of:
- My App/Website (
app_object_id,site_object_id) - Order (
line_item_id) - Campaign (
campaign_id).
- My App/Website (
- Time zone: UTC
- Also supports:
- Filters: OS (
os_name)
- Filters: OS (
OR
- Group by: at least 1 of Day (
day), Week (week), Month (month), combined with at least 1 of My App/Website (app_object_name,site_object_name), Order (line_item_id,line_item_name), Campaign (campaign_id,campaign_name). - Time zone: UTC
- Also supports:
- Group by: OS (
os_name) - Filters: OS (
os_name) or any field used in group by: My App/Website (app_object_id,site_object_id), Order (line_item_id), Campaign (campaign_id)
- Group by: OS (
The new_uniques metric requires:
- Group by: Day (
day), Week (week), Month (month) and OS (os_name) - Filter by: a single selection of:
- My App/Website (
app_object_id,site_object_id) - Order (
line_item_id) - Campaign (
campaign_id).
- My App/Website (
- Time zone: UTC
- Also supports:
- Filters: OS (
os_name)
- Filters: OS (
OR
- Group by: at least 1 of My App/Website (
app_object_name,site_object_name), Order (line_item_id,line_item_name), Campaign (campaign_id,campaign_name) - Time zone: UTC
- Also supports:
- Group by: Day (
day), Week (week), Month (month) and OS (os_name) - Filters: OS (
os_name) or any field used in group by: My App/Website (app_object_id,site_object_id), Order (line_item_id), Campaign (campaign_id)
- Group by: Day (
Cohort Metrics
You can use Cohort metrics. Possible cohort metrics:
| Metrics | Description |
|---|---|
| cohort_size | Cohort Size |
| cohort_retained_users | Retained Users |
| cohort_retention_rate | Retention Rate |
| cohort_revenue | Revenue |
| cohort_roas | ROAS |
| cohort_arpu | ARPU |
| cohort_arppu | ARPPU |
| cohort_cost_per_reattribution | Cost per Reattribution. Require "rt" cohort_user_segments |
When selected cohort metrics you must select Cohort Day Dimensions (cohort_days) and User Segment (cohort_user_segments)
Possible values for cohort_days are: "0", "1", "3", "7", "14", "30".
Possible values of cohort_user_segments:
| Metrics | Description |
|---|---|
| ua | New Installers (UA) |
| rt | Reattributed users |
Filters
| Filters | Description | Sample/ Supported Values |
|---|---|---|
| advertiser_id | Advertiser ID (for enterprise admin user) | Sample Value - 10234 |
| 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 |
| user_state_id | Array of state ids: Kayzen specified ID's for every state | Please refer to States |
| user_city_id | Array of cities ids: Kayzen specified ID's for every city | Please refer to Cities |
| device_model_id | Array of device model ids: Kayzen specified ID's for every device model | Please refer to Device Models |
| manufacturer_id | Array of manufacturer ids: Unique ID for device manufacturers | Please refer to Manufacturers (Device) |
| carrier_id | Array of carrier ids: Unique ID for carriers carriers | Please refer to Carriers |
| traffic_type | Type of traffic on which campaign served. | Supported Value- InAPP, MobileWeb, Unknown |
| has_device_identifier | Presence of device id | Supported Value - -> true - 1 -> false - 0 |
| is_rewarded | Type of rewarded inventory | Supported Value - -> true - 1 -> false - 0 |
| connection_type | Type of user connection. | Supported Values - Carrier Network, Wifi |
| publisher_store_category | Array of app category ids: Kayzen specified value's for every app categories | Please refer to App Categories |
| advertised_app_store_category | Array of app category ids: Kayzen specified value's for every app categories | Please refer to App Categories |
| hour | Hour | 24 hour format, e.g., 3 or 21 |
| smart_category | Publisher Smart App Categories - Categories | Sample Value- "Casual Games" |
| smart_genre | Publisher Smart App Categories - Genres | Sample Value- "Simulation" |
| smart_subgenre | Publisher Smart App Categories - Subgenres | Sample Value- "Weapon Simulator" |
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 |
| hour | Hour of the day. Range is 0-23 | Sample Value - 1 (for 01:00) |
| 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 |
| device_model | Names of the device models | Supported Values - SM-G960U |
| is_ssl | Specify whether creative's click and impression URL were secure url's or not | Supported Values - 0 - Non Secure 1- Secure |
| has_device_identifier | Specifies whether the impression was served on a bid request which had user identifier (IDFA/GAID) present or missing | Supported Values - 0 - Device identifier not present 1- Device identifier present |
| is_rewarded | Specifies whether the impression was served on a rewarded inventory or not | Supported Values - 0 - Non rewarded inventory 1- Rewarded inventory |
| 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 | Advertiser app's android package Name / iOS App ID | 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-2 digit ISO country code for every country | Sample Value - US for The United States of America |
| state_name | List of State names | Sample Value - California |
| state_code | State Code as defined by ISO-3166-2 standard of all countries coded in ISO 3166-1 | Sample Value - US-CA |
| city_name | List of City names | Sample Value - San Francisco |
| traffic_type | Type of traffic on which campaign served | Supported Value - InAPP MobileWeb Unknown |
| carrier_name | List of the user's network names | Sample Value - Vodafone |
| 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 |
| publisher_store_category | App store category in Kayzen platform | Please refer to App Categories |
| advertised_app_store_category | App store category in Kayzen platform | Please refer to App Categories |
| smart_category | Publisher Smart App Categories - Categories | Sample Value - "Casual Games" |
| smart_genre | Publisher Smart App Categories - Genre | Sample Value - "Simulation" |
| smart_subgenre | Publisher Smart App Categories - Subgenre | Sample Value - "Weapon Simulator" |
| smart_is_gaming | Publisher Smart App Categories - Is Game | Sample Value - "YES" |
Attribution Sources
| Title | Description |
|---|---|
| mmp | Values based on MMP attribution. For instance, the install count based on MMP attribution |
| self | Values based on Self attribution. For instance, the install count based on Self attribution |
| assisted | Difference between MMP and Self assisted attribution numbers for a given metric. Represented as percentage |
Attribution Types
| Title | Description |
|---|---|
| click | Attribution values based on last Click attribution |
| view | Attribution values based on last view attribution |
| total | Sum of Click through (CT) and View through (VT) attribution |