The Kochava platform provides extensive tools to track everything from impressions thru post-install events for connected devices. The API reporting method provides advertisers with the programmatic tools to gather performance data on an on-demand or scheduled basis.
For clarity, our support documentation for API v1.4 has been divided into the following sections:
- Call Structure
- Querying API
- Requesting and Scheduling Reports
This document describes the structure used within the API. For more information about generating an API key, refer to our Create and Manage API Key support documentation.
API Call Structure
| Parameter | Description | Format | Valid in Report | Req. |
|---|---|---|---|---|
| api_key | The API key linked to the user pulling the report. | string | Summary Detail Custom | Yes |
| app_guid | Unique app ID that includes the app name and an alphanumeric string. | string | Summary Detail Custom | Yes |
| time_start | Epoch format in seconds. Start time of the report, must be entered as a full hour (e.g., 2:00 acceptable, 2:15 not acceptable). | string | Summary Detail Custom | Yes |
| time_end | Epoch format in seconds. End time of the report, must be entered as a full hour (e.g., 2:00 acceptable, 2:15 not acceptable). | string | Summary Detail Custom | Yes |
| traffic | Traffic type and counters needed on which to report. | [string] | *Summary (click, impression, install, event, reengagement, trafficverif) *Detail (click, impression, install, event, reengagement, influencer_imp, influencer_click, fractional) | Yes |
| traffic_including | What you want to include in addition to the regular fields for the detail report. | [string] | Detail- custom_parameters: for clicks, install and events – add the custom parameters passed with the click identitylink: install and event traffic_verification: unattributed_traffic: Shows the organic install in the report. If not present, only matched will show. unattributed_only: Only show organic installs include_san_claim_data: Provides SAN network claim data when added to the API call. | No |
| traffic_grouping | **The manner in which the summary report is grouped by. By default, the date (based on time series) and any other field included. | [string] | Summary | No |
| time_zone | What time zone should the date fields be shown in, in addition to UTC. (“America/New_York”, “America/Vancouver”, “America/Los_Angeles”, “Asia/Seoul”, “Europe/Paris”) | string | Summary Detail | No |
| time_series | ***Grouping period. | string | Summary | Yes |
| traffic_filtering | What the report is limited to. The format is what the values should be (similar to in […]). Filtering by country can be accomplished by using the two-letter country code. Filtering on the network and campaign can be accomplished by using the associated ID. The list can be obtained by using the getfiltering call. | map[string][string] | Summary Detail | No |
| delivery_format | The format in which the report is generated (comma delimited or JSON). | string | Summary Detail Custom | Yes |
| delivery_method | The means by which the report is delivered (S3link). | [string] | Summary Detail Custom | No |
| notify | The email to which the report link is sent. | [string] | Summary Detail Custom | No |
| currency | ****The format for which currency will be shown/converted to in reporting. | [string] | Detail (event) | No |
| columns_order | If not specified, all columns will be exported on the report, and the size of the file will reflect it (size can exceed 1 GB). The array should contain the desired columns for the report. Once the report has been generated, an extra process will limit the output to the columns listed AND in the same order as the list for CSV files. For JSON files, the fields will be limited to the list BUT the ordering will not apply. Passing [“default”] for this parameter forces the system to look up the database and return the columns as saved in the database used by the UI. By using this, if a client set-up a specific design for a report/APIKey/app in the UI, the same design will be available thru the API without having to pass the list of columns during the call. If there is no entry for the report/APIKey/app, the system will use the default configuration set-up for that report type. | [string] | Detail | No |
*For Detail reports limited to one traffic type; Summary can contain more than one traffic type.
** The list of fields can be obtained by using the grouping call.
*** 1=1 hour, 4=4 hour blocks (0-4, 4-8, 8-12, 12-16, 16-20, 20-24), if 24, group by day.
**** Value must be formatted as JPY, GBP, USD etc. For a full list of available currency values, refer to our Analytics Page Tools support documentation.
