Monetization Stats API
Use the Monetization Stats API to programmatically access your ad performance data in CSV format for custom reporting and analysis.
Read time 2 minutesLast updated a day ago
Use the Monetization Stats API to retrieve monetization data directly in CSV format. The API fetches the same statistics that are available on the developer dashboard, however you can use it to programmatically pull data for your own uses.
Important
Mediation partners need a Unity API key in order to gather accurate reporting for the Unity Ads network. If you already use the deprecated Applifier Statistics API in your mediated integration, consult your mediation partner before migrating to the Monetization Statistics API. Note that you can still use the Monetization Statistics API to ping Unity's network for reporting data directly. All unmediated customers can safely migrate to the new API.
Authentication
Note
The Monetization Stats API requires your Organization ID, and that ID will be changed when transferring a project.
Note
Transferring a project changes the Organization ID, which is required for accessing the Monetization Statistics API.
Note
The Monetization Statistics API generates a unique key for each user. For mediation integration purposes, any individual's key will work for the entire Organization.
"apikey=<token>""Authorization: Token <token>"400 {"errors":[{"msg":"access token required"}]}
Request Format
To retrieve statistics data from the Unity Ads service, use the following GET request, where<organizationId>GEThttps://monetization.api.unity.com/stats/v1/operate/organizations/<organizationId>
Query parameters
The API supports various ways to split your data. Some are required for a successful request.Parameter | Description | Required? | Notes |
|---|---|---|---|
| The API authentication key retrieved from the Monetization dashboard. | No. Use the Authentication header instead. | Not applicable. |
| A comma-separated list that defines the columns of available fields:
| Yes | Not applicable. |
| A comma-separated list that expands the rows, splitting data by the following fields:
| No | Not applicable. |
| A value that splits data by time resolution. Each day splits at 00:00 UTC. Supported options include:
| Yes | Not applicable. |
| The start time of data set, in ISO 8601 format. | Yes | Not applicable. |
| The end time of data set, in ISO 8601 format. | Yes | Not applicable. |
| A comma-separated list of source game IDs by which to filter results. | No | To obtain source IDs, you can make a request using |
"Accept"- For CSV, use .
"Accept: text/csv" - For JSON, use .
"Accept: application/json"
curlhttps://monetization.api.unity.com/stats/v1/operate/organizations/:organizationId?groupBy=country,placement,platform,game&fields=adrequest_count,available_sum,revenue_sum,start_count,view_count&scale=hour&start=2020-05-01T00:00:00Z&end=2020-06-01T23:59:00Z&apikey=:apiKeyValue -H "Accept: text/csv" --output stats.csv
Note
Splitting data across multiple dimensions causes the CSV to grow exponentially, which might cause some large data sets to time-out. The request times out if the server takes more than 60 seconds to process the request.
Request status codes
The endpoint returns the following status codes indicating the result of the request:Code | Description |
|---|---|
| The request succeeded. |
| The |
| The API key is missing from the request or invalid. |
| Organization not found. |
| The request timed out. |
| Request rate limit exceeded. |
| The request failed for an unknown reason. |
| The service is unavailable. |