Advertising Statistics API
Note: The following documentation applies to the current API version; aspects of the domain and functionality are subject to change for general release.
The Statistics API is an HTTP interface that allows advertisers to retrieve acquisition statistics data in CSV format.
SKAdNetwork conversion value data
The Stats API now allows advertisers to start to receive SKadNetwork conversion value data. This supports using SKAd conversion values:
- as a
- as a filter via the
This functionality is in addition to the recently launched SKAdNetwork install reporting. It's provided to assist advertisers who wish to test the new SKAdNetwork conversion values throughout March 2021, to prepare for Apple's anticipated roll-out of the Apple ATT for iOS14.
Using the Unity Ads Statistics API requires an API key token. You can generate an API key token from dashboard by selecting Settings from the left navigation bar.
Note: The API key is generated for an specific username. If that username is removed from the organization, that API key will be automatically revoked. Please be aware of this if you use the API key as part of an integration with a 3rd party or any other business intelligence solution.
You can use the key token in two ways:
- Place the key token in the GET request URL
apikeyparameter. For example:
- Place the key token in the
Authorizationheader of the GET request, prefixed with
Bearer. For example:
curl https://stats.unityads.unity3d.com/organizations/:organization_id/reports/acquisitions -H "Authorization: Bearer <token>"
Make a GET request to the following example URL:
The following parameters define the period and scope of requested data:
||Start time of the data query; required.||
||End time of the data query; required.||
||Time resolution of the data (default is
Example time format:
You can apply the following list of filters to your request:
||A comma-separated list of campaign set IDs to filter.||
||A comma-separated list of campaign IDs to filter.||
||A comma-separated list of target game IDs to filter.||
||A comma-separated list of ad types to filter.||
||A comma-separated list of country codes to filter (for example,
||A comma-separated list of app stores to filter.||
||A comma-separated list of platforms to filter.||
||A comma-separated list of operating system versions to filter (for example,
||A comma-separated list of creative packs to filter.||
||A comma-separated list of source app IDs to filter. This ID is an identifier derived from the game's app store page. Prior to migration, this was called
||A comma-separated list indicating external supply sources to filter. Possible values are
||A comma-separated list of SKAdNetwork conversion values to filter. These values must be integers between 0 and 63.||
In addition, you can specify a comma-separated list of dimensions by which to split data:
The following allows you to specify comma-separated fields to display in your report:
fields=[(timestamp|campaignSet|creativePack|adType|campaign|target|sourceAppId|store |country|platform|osVersion|starts|views|clicks|installs|spend)] (default:all)
Note: If you omit the fields parameter, all fields will be output. The default fields are:
Note: The identifiers
source_game_id have been deprecated. They have been replaced with
source_app_id). While the deprecated source_game_id was an integer, the identifier
source_app_id)is a case-sensitive, 12-character, alphanumeric string. For more information, please see the FAQs.
SKAD specific fields
|skadInstalls||Installs from Apple’s SKAdNetwork.|
|skadCpi||CPI calculated based on installs from Apple’s SKAdNetwork.|
|skadConversion||Conversion calculated based on installs from Apple’s SKAdNetwork.|
- SKAd specific fields are not available by default in the response and therefore should be explicitly specified in the fields parameter if required.
- In addition, fields above will not be available for the creativePack, adType and osVersion filters since we do not get this granularity of data within the SKAd postbacks.
The data returns in CSV format, with the following delimiters:
- Commas (
,) separate fields
- Periods (
.) indicate decimals
- Double quotes (
" ") indicate text fields
- The newline character separates lines within a field
campaignSet data results in two fields:
campaign set id
campaign set name
campaign data results in two fields:
creativePack data results in two fields:
creative pack id
creative pack name
target data results in three fields:
target store id
Note: Splitting data by too many dimensions may impact response times for querying the API. To avoid lagging or timeouts, we recommend querying 1 day of data at a time when splitting by
$ curl -L "https://stats.unityads.unity3d.com/organizations/:organizationId/reports/acquisitions splitBy=campaignSet,country&fields=timestamp,campaignSet,country,clicks,installs,spend&apikey=<token>" timestamp,campaign set id,campaign set name,country,clicks,installs,spend 2013-03-01T00:00:00.000Z,50ed569d57fe1f324a15fbf7,"Campaign set #5",AU,71,30,45 2013-03-01T00:00:00.000Z,50ed569d57fe1f324a15fbf7,"Campaign set #5",CA,129,88,132 CONFIDENTIAL, Unity Technologies 2017 Advertiser Stats API2013-03-01T00:00:00.000Z,50ed569d57fe1f324a15fbf7,"Campaign set#5",US,1745,855,1282.5 2013-03-01T00:00:00.000Z,50eeb7339e10c9d21c0225cb,"Campaign set#6",AT,39,19,28.5 2013-03-01T00:00:00.000Z,50eeb7339e10c9d21c0225cb,"Campaign set #6",AU,16,10,15 2013-03-01T00:00:00.000Z,50eeb7339e10c9d21c0225cb,"Campaign set #6",BE,209,120,180