Support Home > Analytics, Reports & API > API v1.1 – Requesting and Scheduling Reports

API v1.1 – Requesting and Scheduling Reports

DOCUMENT SUPERSEDED: The information that is contained within this document has been superseded. Refer to the current API Requesting and Scheduling Reports support document for the latest integration instructions and procedures.

The Data Access API Integration provides additional reporting tools to supplement those available through the Kochava platform.

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.1 has been divided into the following sections:

 

This document defines the methods for pulling new reports and creating scheduled reports utilizing the API.

 

NOTE: For details on the parameters available within each report, refer to our Reports Overview support documentation.


Requesting a New Summary Report

A Summary Report is a report showing counters for the traffic requested for a specific timeframe, and grouped by the fields requested in the API call. More than 1 counter can be selected by including multiple “traffic” parameters.

 

Clicks Counters:

  • # clicks
  • # duplicate clicks
  • # clicks matched to impressions
  • # amount spent on clicks

 

Installs Counters:

  • # installs
  • # installs matched to impressions
  • # installs matched to clicks

 

Impression Counters:

  • # impressions
  • Amount spent on Impression

 

Reengagement Counters:

  • # reengagment for

 

Event Counters:

  • # events
  • # revenue generating events
  • Amount of revenue generated

 

Traffic Verification Counters:

  • # clicks verified OK
  • # clicks verified NOT OK
  • # installs verified OK
  • # installs verified NOT OK

 

NOTE: The Summary Report can be filtered on country, network, site, campaign, tracker and creative.

 

Post Endpoint:

https://reporting.api.kochava.com/v1.1/summary

 

Sample Post Data:

 

Successful Response Example:

 

Error Response Example:


Requesting a New Detail Report

A Detail Report is a report showing original data for the traffic requested for a specific time range requested in the API call.

 

Available Reports:

By using the Traffic key the following reports are available –  click, impression, install, event, reengagement, influencer_imp, influencer_click, collected cost, and fractional.

 

NOTE: For event traffic, the following events are excluded _Install, _Click, _SessionBegin and _SessionEnd.

NOTE: The Detail Report can be filtered on:

  • Event Report – event_name (as long as not starting with _) and network
  • Influencer (click and impression) – network
  • Fractional – network (winning)
  • Click/Impression/Reengagment – network, tracker
  • Install – network, country, site and tracker
  • Reengagement Report – event_name

NOTE: If a filter is included with the request on events, only that event_name will be selected.

NOTE: In order to view the currency generated by an event in a specific format, such as YEN, add a JSON entry such as:

  • “currency”: “JPY”

Two columns will be added to the Event Detail report displaying the currency type and value.

 

Post Endpoint:

https://reporting.api.kochava.com/v1.1/detail

 

Sample Post Data:

 

Successful Response Example:

 

Error Response Example:


Requesting a Detail Report with Limited/Reordered Columns

Using this method will return a report with the specified columns in the exact order specified.

 

Post Endpoint:

https://reporting.api.kochava.com/v1.1/detail

 

Sample Post Body:

 

Successful Response Example:

 

Error Response Example:


Requesting a Detail Report Designed through the User Interface

Using this method will return a report with the specified columns as designed within the User Interface.

 

Post Endpoint:

https://reporting.api.kochava.com/v1.1/detail

 

Sample Post Body:

 

Successful Response Example:

 

Error Response Example:


Obtaining a Report Status

Once a report has been successfully submitted, the status of the report can be obtained through an API call.

 

Post Endpoint:

https://reporting.api.kochava.com/v1.1/progress

 

Sample Post Body:

 

Successful Response Example:

 

Error Response Example:


Delete a Queued Report

While a report is queued, it may be deleted. Once the report has run or is running, the operation cannot be canceled.

 

Post Endpoint:

https://reporting.api.kochava.com/v1.1/delete

 

Sample Post Data:

 

Successful Response Example:

 

Error Response Example:


Request a List of Apps by API Key

It is possible to view a list of the apps that are associated with a specific API key.

 

Post Endpoint:

https://reporting.api.kochava.com/v1.1/getapps

 

Sample Post Data:

 

Successful Response Example:

 

Error Response Example:


Reports Generated by API Key

It is possible to view the last reports submitted by a specific account (App GUID).

 

Post Endpoint:

https://reporting.api.kochava.com/v1.1/tokens

 

Sample Post Data:

 

Successful Response Example:


Scheduling Reports Overview

Reports can be scheduled to run repeatedly as needed on a hourly, daily, weekly, monthly or quarterly basis. The start date and end date need to be calculated for every report that is run.

 

The following fields will assist in the scheduling:

 

Field Description
runon Defines when the report will run.
delay The value used to calculate the end date of the report from the runon time.
previoustime The difference between the start and end time.

 

Frequency RunOn Delay PreviousTime* Description
hourly Min
0
0
35
15
45
Min
0
30
5
15
15
Min
60
30
30
120
60
on the hour for the previous 60 min
on the hour for the first 30 min of previous hour
at 35 past the hour for the first 30 min of the day
at 15 past the hour for the previous 2 full hours
at 45 past each hour, for 60 min (hour -1 :30 to hour:30)
daily Hour
0
13
2
Hour
0
1
2
Hour
24
24
48
Start @ 0:00 for the past full day (24 hours)
Start @ 1:00 PM for the past 24 hrs (day -1 12:00 PM to 12:00PM)
Start @ 2:00 for the past full 2 days >=day-2@00:00 and < day:00:00(48 hours)
weekly dayID
1
1
6
1
Day
0
1
0
0
Day
7
7
5
2
Start on Monday @ 0:00 for the previous week (Mon->Sund)
Start on Monday @ 0:00 for the previous week (Sund->Sat)
Start on Saturday @ 0:00 for the previous weekday (Mon->Frid)
Start on Monday @ 0:00 for the previous weekend (Sat,Sund)
monthly dayDate
1
15
16
1
Day
0
14
0
0
Month
1
2
2
6
Run on the 1st of the month @ 0:00 for the entire previous month.
Run on the 15th of the month @ 0:00 for the previous 2 months
Run on the 16th for the previous month and 1/2 (1st of month -1 to 15 of current month)
Run on the 1st of the month @ 0:00 for the previous 6 months.

*The unit for “previous time” is different for each frequency because an hour/day/week is fixed. Month and Quarter are not fixed.

 

API Structures:

The structure for APIs are similar to the structures listed in the API Reporting Structure Section, with the following differences:

Parameter Difference Description Format Valid in Report Req.
time_start Removed
time_end Removed  –
frequency Added How often the report should run (hourly, daily, weekly, monthly or quarterly). string Summary
Detail
Custom
Yes
run_on Added When the report should run (on the x day, hour, minute, etc.). string Summary
Detail
Custom
Yes
previous_time Added What period of time is included in the report. string Summary
Detail
Custom
Yes
delay Added What is the end date of the report, based on when it ran. string Summary
Detail
Custom
Yes

Schedule a New Summary Report

Post Endpoint:

https://reporting.api.kochava.com/v1.1/schedule/summary

 

Sample Post Data:

 

Successful Response Example:


Schedule a New Detail Report

Post Endpoint:

https://reporting.api.kochava.com/v1.1/schedule/detail

 

Sample Post Data:

 

Successful Response Example:


Schedule a New Detail Report with Selected Columns

This call enables a Detail Report to be generated with a list of selected columns in the desired order.

 

NOTE: A default may be created and saved with the UI and called using the value “column_order”: [“default”].

 

Post Endpoint:

https://reporting.api.kochava.com/v1.1/schedule/detail

 

Sample Post Data:

 

Successful Response Example:


Obtain the Status of a Scheduled Report

Post Endpoint:

https://reporting.api.kochava.com/v1.1/schedule/progress

 

Sample Post Data:

 

Successful Response Example:


Deleting a Scheduled Report

Post Endpoint:

https://reporting.api.kochava.com/v1.1/schedule/delete

 

Sample Post Data:

 

Successful Response Example:


Scheduled Reports Generated by API Key

It is possible to view the last reports submitted by a specific account (API key).

Post Endpoint:

https://reporting.api.kochava.com/v1.1/schedule/tokens

 

Sample Post Data:

 

Successful Response Example:

 
 

Last Modified: Sep 1, 2017 at 3:45 pm