The reporting API offers advertisers a programmatic way to access data that is present on the dashboard. Your Reporting API Key is the same for all of your apps. Each app has a unique Reporting API ID, which you can find on its respective application page. You can find your Reporting API Key here.
Security is handled in the request header. Find your API key in the account page on the Vungle dashboard. If you don't already have an API Key, email email@example.com to request one! If you are getting authentication error, try to refresh the key on the Vungle Platform.
|Authorization||Bearer [API Key]||API Key|
|Accept:||text/csv or application/json||Accepted data format for results. Default is text/csv.|
- Format: We support JSON and CSV outputs, specified in the request header.
- Date range: Historical information is available for up to six months. To retrieve older data, email your account manager at firstname.lastname@example.org.
- In the event of no data: Please note that if there is no data available for your query, Vungle sends back an empty 200 response. This indicates that the request has succeeded, but there is no data available to return.
We use UTC as default time zone. It is not able to be changed so far.
Resource: GET /reports/spend
Use filter parameters to restrict the results to a subset of your spend data. Most filters are optional, in which case Vungle returns all results for that filter.
|Parameter name||Format||Action||If Unavailable||Example|
|start||ISO8601 date||Limits the result set to data no earlier than this date||Rejects request||start=2019-01-0|
|end||ISO8601 date||Limits the result set to data no later than this date||Rejects request||end=2019-01-02|
|country||Comma-separated list of ISO 3166-1 Alpha-2 country codes||Returns only spend data matching the listed countries||Returns all countries||Returns all countries
Returns all countries
|applicationId||Comma-separated list of Vungle Application IDs to return||Returns only spend data for the listed applications||Returns all applications||applicationId=586e201e242e3fd308000220
|campaignId||Comma-separated list of Vungle campaign IDs||Returns only data for the listed campaigns||Returns all campaigns||campaignId=586e201e242e3fd308000220
|creativeId||Comma-separated list of Vungle creative IDs||Returns only spend data for the listed creatives||Returns all creatives||creativeId=586e201e242e3fd308000220
|siteID||Comma-separated list of publisher app object Ids||Returns only spend data for the listed applications||Returns all publishers||siteId=586e201e242e3fd308000220
|accountID||Comma-separated list of publisher app object Ids||Returns only spend data for the listed applications||Returns all accounts||account ID=58e71dd7294039844b0001c7|
|placementID||Comma-separated list of publisher app object Ids||Returns only spend data for the listed applications||Returns all placement||placementID=5bc9877224291f02aee8741c|
|eventModelType||Comma-separated model types||Returns only spend data for the listed applications||Returns all types||eventModelType=ltv
Use dimensions to make your reports more or less granular. Send dimensions as a comma-separated list under a dimensions parameter. If you do not explicitly request a dimension, Vungle does not break the report down by that dimension.
Using the dimensions parameter
|dimensions||Comma-separated list of specific strings, listed in the table below||dimensions=platform
|Dimension name||Returns||Example return||End Points|
|platform||Grouped by platform string||platform
|campaign||Grouped by campaign ID and campaign Name||campaign id
Toy Blast iOS CA iPhone
|date||Grouped by date||date
|country||GGrouped by country||country
|creative||Grouped by creative Id and creative name||creative id
Toy Blast Landscape IEC
|site||Grouped by publisher app object Id and publisher app name||site id
Sonic Dash iOS
|eventModelType||Grouped by Model Type||ltv,cpa||CPA|
For dimensions requiring a name lookup (for example, Site Name), if Vungle is unable to retrieve the lookup, we return an 'Unknown' string in place of the name.
Use aggregates to define which performance data interests you. Send aggregates as a comma-separated list under an aggregates parameter. If an aggregate is not in the list, Vungle assumes that you do not wish to receive that data.
Using the aggregates parameter
|aggregates||Comma-separated list of specific strings, listed in the table below||aggregates=views
|ecpm||(spend * 1000 / views) as a float||spend|
Example 1: JSON Spend
curl -i -H "Authorization: Bearer [API KEY]" -H "Vungle-Version:1" -H "Accept:application/json" -X GET "https://report.api.vungle.com/ext/adv/reports/spend?dimensions=date,country,platform&aggregates=views,spend&start=2019-01-01&end=2019-01-01
"platform" : "iOS",
"platform" : "Android",
Example 2: CSV Spend
curl -i -H "Authorization: Bearer [API KEY]" -H "Vungle-Version:1" -H "Accept:application/json" -X GET "https://report.api.vungle.com/ext/adv/reports/spend?dimensions=date,country,platform&aggregates=views,spend&start=2019-01-01&end=2019-01-01"
Example 3: ID/Name Expansion
curl -i -H "Authorization: Bearer [API KEY]" -H "Vungle-Version:1" -H "Accept:application/json" -X GET "https://report.api.vungle.com/ext/adv/reports/spend?dimensions=campaign&aggregates=views,spend&start=2019-01-01&end=2019-01-01"
"campaign id" : "12345678",
"campaign name": "test campaign 1",