Learn how to retrieve campaign metrics based on specific breakdowns and filters. Understand the method, endpoint, supported parameters, and how to authenticate your request for optimal data retrieval.
Description: Retrieves campaign metrics for an advertiser based on the requested breakdowns and filters. The data can be retrieved in JSON or CSV format.
Method: GET
URL Supported Parameters
Name | Data type | Description | Possible values |
start_date (mandatory) | Date in format: YYYY-MM-DD | Limit to last 6 months | 2018-09-01 |
end_date (mandatory) | Date in format: YYYY-MM-DD |
| 2018-09-30 |
metrics (mandatory) | A comma-separated list of strings | A list of metrics to be included in the response. | impressions, clicks, launches, completions, installs, spend |
breakdowns | A comma-separated list of strings | A list of breakdowns by which the response data is returned. | Day, app_name, package_name, campaign_id, campaign_name, cost_model, publisher_id, publisher_name, country, state, city, language, gender, age, device_manufacturer, device_model, os, sim_operator, campaign_segment_id, campaign_segment_name |
format | String | The format of the response. The default is JSON | json | csv |
count | Integer | Maximum number of records to return in the response | 10,000 (default) |
campaign_ids | A comma-separated list of integers | List of campaign IDs to filter | 4254731,4225277 |
package_names | A comma-separated list of strings | Package names to filter | com.contextlogic.wish,com.cliqz.browser |
countries | A comma-separated list of strings | Countries to filter | US, GB |
campaign _names | A comma-separated list of strings | Campaign names to filter | CampaianAbc_US |
app_names | A comma-separated list of strings | List of app names to filter | App Name |
Authentication
In order to keep the API secured, we use a token for authentication.
Please contact your account manager to receive the token.
In the header of each request add an Authorization header with the token.
Request example
curl -X GET \
-H 'authorization: the_token_uuid'