Reporting API Documentation

Overview

The reporting API is meant to give advertisers and publishers a programmatic way to access data that is present on the dashboard. Your Reporting API Key will be the same for all of your apps. Each app will have a unique Reporting API ID, which can be found on its respective application page.

Host Request Headers API
https://ssl.vungle.com Content-Type: application/json Security is handled by passing an API key as a query parameter. Your API Key is automatically generated on the Vungle Dashboard.  
If you don't have one already, see How can I request a Reporting API Key?

Advertisers

Resource Parameters Description
GET /api/campaigns key=[API Key] active=[true/false] Returns a list of the campaigns you own. If active is specified, the campaigns will be filtered to show only active or inactive campaigns.

Example Response:

{   
    "rate" : 0.01,
    "rateType" : "complete",
    "campaignId" : "51896da23436ae313c3939b9",
    "type" : "external",
    "name" : "Feed the Rat",
    "spent" : 2131
}

Resource Parameters Description
GET /api/campaigns/[Campaign ID] key=[API Key] date=[YYYY-MM-DD] Returns the statistics for the specified campaign on the specified date.

Example Response:

{
    "clicks" : 1129,
    "completedViews" : 23080,
    "date" : "2012-08-19",
    "campaignId" : "51896da23436ae313c3939b9",
    "installs" : 590,
    "impressions" : 26722,
    "name" : "Feed the Rat",
    "views" : 26546,
    "dailySpend": 566
}
Resource Parameters Description
GET /api/campaigns/[Campaign ID]/installs key=[API Key] start=[YYYY-MM-DD] end=[YYYY-MM-DD] Returns a list of the installs that have been attributed to the specified campaign during the specified date range.

Example Response:

{
    "time_clicked": "2012-08-17T01:52:32.024Z",
    "time_installed": "2012-08-17T01:54:33.034Z",
    "openUDID": "e2c42c159286124f34702e770cc702240c2707e8",
    "mac": "98d6bb786fdd"
},
{
    "time_clicked": "2012-08-17T01:52:32.024Z",
    "time_installed": "2012-08-17T01:54:33.034Z",
    "openUDID": "e2c42c159286124f34702e770cc702240c2707e8",
    "mac": "98d6bb786fdd"
}

Geo Level Metrics

Resource Parameters Description
GET /api/campaigns/[Campaign ID]/geo/[Country_Code] key=[API Key] date=[YYYY-MM-DD] OR start=[YYYY-MM-DD] end=[YYYY-MM-DD]

Returns the geo information for a campaign in specific countries. The country is specified using a two letter Country_Code e.g. US. You can either enter a date range using the 'start' and 'end' parameters or a specific 'date' but not both. 

Example Response:

{
"date": "2015-07-08",
"country": "US",
"views": 34029,
"completes": 32094,
"clicks": 1822,
"installs": 609,
"spend": 582,
"eRPM": 8.9
}
Resource Parameters Description
GET /api/campaigns/[Campaign ID]/geo/all key=[API Key] date=[YYYY-MM-DD] OR start=[YYYY-MM-DD] end=[YYYY-MM-DD]

Returns the geo information for a campaign over all countries. You can either enter a date range using the 'start' and 'end' parameters or a specific 'date' but not both. 

Example Response:

[
{
"date": "2015-07-08",
"country": "US",
"views": 34029,
"completes": 32094,
"clicks": 1822,
"installs": 609,
"spend": 582,
"eRPM": 8.9
},
{
"date": "2015-07-08",
"country": "CA",
"views": 34235,
"completes": 3190,
"clicks": 1509,
"installs": 523,
"spend": 498,
"eRPM": 7.6
}
]

Publishers

Resource Parameters Description
GET /api/applications key=[API Key]
geo=[Country_Code] or geo=all
Returns a list of the applications you own.

Example Response:

{
    "id": "51896d9c3436ae313c3939b8",
    "appId" : "com.amazingGames.ProjectComet",
    "name" : "Project Comet", 
    "installs" : 1372,
    "platform" : "iOS",
    "connection" : "all", 
    "status" : "a"
}

Note, id and appId value will be same for newly created applications.

Resource Parameters Description
GET /api/applications/[REPORTING API ID] key=[API Key]
date=[YYYY-MM-DD] or start=[YYYY-MM-DD] end=[YYYY-MM-DD]
geo=[Country_Code] or geo=all
Returns a list of the statistics for the specified application on the specified date(s).

Example Response:

{
    "date" : "2012-08-16",
    "impressions" : 5165,
    "views" : 5156,
    "completes" : 1686,
    "revenue" : 16.86,
    "eCPM" : 3.26
}

Please note that if there is no data available for your query an empty 200 response will be sent back. This reflects that the request has succeeded but that there is no data available to return.

Have more questions? Submit a request

Comments