Downloadable Document
...
Password: password123
Reports
...
Performance Report
Unversioned
See the newest version of the API
...
| Field | Description | Type |
|---|---|---|
| startDate | yyyy-MM-dd | Date |
| endDate | yyyy-MM-dd | Date |
| clickCount | Number of clicks for all campaigns | Integer |
| preloadCount | Number of preloads for all campaigns | Integer |
| installCount | Number of installs for all campaigns | Integer |
| ctr | CTR for all campaigns, or for specific tier | Float |
| spend | Spending for all campaigns, or for specific tier | Float |
| cpi | CPIfor all campaigns, or for specific tier | Float |
| conversionRate | Conversion rate (Installs / Preloads) | Float |
| campaignId | Digital Turbine's numerical identifier for the campaign | Integer |
| campaignName | The headline text for the campaign | String |
| platform | The platform the campaign is running on | String |
| siteId | Digital Turbine's numerical identifier for a device | Integer |
| appIdentifier | iTunes ID or Android Package Name | String |
| name | Name of the tier | String |
| countryCode | ISO 2 letter country code | String |
| countryName | Country name | string |
Sample Response (JSON)
| Code Block | ||||
|---|---|---|---|---|
| ||||
{"performance":{"startDate":"2021-04-07","endDate":"2021-04-07","clickCount":14,"installCount":14,"preloadCount":0,"conversionRate":1.0000,"ctr":null,"spend":70.00,"cpi":5.00,"tiers":[{"name":"Default","clickCount":14,"installCount":14,"preloadCount":0,"conversionRate":1.0000,"ctr":null,"spend":70.00,"cpi":5.00}],"countries":[{"countryCode":"US","countryName":"United States","clickCount":14,"installCount":14,"preloadCount":0,"conversionRate":1.0000,"ctr":null,"spend":70.00,"cpi":5.00}],"campaigns":[{"campaignId":11111,"campaignName":"DT Test","appIdentifier":"com.google","platform":"ANDROID","sites":[{"siteId":12605,"tiers":[{"name":"Default","clickCount":14,"installCount":14,"preloadCount":0,"conversionRate":1.0000,"ctr":null,"spend":70.00,"cpi":5.00}],"countries":[{"countryCode":"US","countryName":"United States","clickCount":14,"installCount":14,"preloadCount":0,"conversionRate":1.0000,"ctr":null,"spend":70.00,"cpi":5.00}],"days":[{"date":"2021-04-07","tiers":[{"name":"Default","clickCount":14,"installCount":14,"preloadCount":0,"conversionRate":1.0000,"ctr":null,"spend":70.0000,"cpi":5.00}]}]}]}]}}
|
Sample Response (XML)
| Code Block | ||||
|---|---|---|---|---|
| ||||
<report>
<performance>
<startDate>2018-09-12</startDate>
<endDate>2018-09-12</endDate>
<clickCount>0</clickCount>
<installCount>3489</installCount>
<preloadCount>19542</preloadCount>
<conversionRate>0.1785</conversionRate>
<ctr xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:nil="true"/>
<spend>6334.35</spend>
<cpi>1.82</cpi>
<tiers>
<tier>
<name>Default</name>
<clickCount>0</clickCount>
<installCount>3489</installCount>
<preloadCount>19542</preloadCount>
<conversionRate>0.1785</conversionRate>
<spend>6334.35</spend>
<cpi>1.82</cpi>
</tier>
</tiers>
<countries>
<country>
<countryCode>US</countryCode>
<countryName>United States</countryName>
<clickCount>0</clickCount>
<installCount>3489</installCount>
<preloadCount>19542</preloadCount>
<conversionRate>0.1785</conversionRate>
<spend>6334.35</spend>
<cpi>1.82</cpi>
</country>
</countries>
<campaigns>
<campaign>
<campaignId>90909</campaignId>
<campaignName>APPIAGame-US_Generic_Ignite_CPI</campaignName>
<appIdentifier>com.appia.android/appIdentifier>
<platform>ANDROID</platform>
<sites>
<site>
<siteId>9090</siteId>
<tiers>
<tier>
<name>Default</name>
<clickCount>0</clickCount>
<installCount>214</installCount>
<preloadCount>1873</preloadCount>
<conversionRate>0.1143</conversionRate>
<spend>181.90</spend>
<cpi>0.85</cpi>
</tier>
</tiers>
<countries>
<country>
<countryCode>US</countryCode>
<countryName>United States</countryName>
<clickCount>0</clickCount>
<installCount>214</installCount>
<preloadCount>1873</preloadCount>
<conversionRate>0.1143</conversionRate>
<spend>181.90</spend>
<cpi>0.85</cpi>
</country>
</countries>
<days>
<day>
<date>2018-09-12</date>
<tiers>
<tier>
<name>Default</name>
<clickCount>0</clickCount>
<installCount>214</installCount>
<preloadCount>1873</preloadCount>
<conversionRate>0.1143</conversionRate>
<spend>181.9000</spend>
<cpi>0.85</cpi>
</tier>
</tiers>
</day>
</days>
</site>
</sites>
</campaign>
</campaigns>
</performance>
</report> |
Sample Error Response
| Code Block | ||||
|---|---|---|---|---|
| ||||
<report>
<errors>startDate must be earlier than 2018-09-13</errors>
<errors>endDate must be earlier than 2018-09-13</errors>
</report>
|
Sample No Data Response (JSON)
| Code Block | ||||
|---|---|---|---|---|
| ||||
{"performance":{"startDate":"2021-02-11","endDate":"2021-02-11","clickCount":0,"installCount":0,"preloadCount":0,"conversionRate":0.0000,"ctr":null,"spend":0.00,"cpi":0.00,"tiers":[],"countries":[],"campaigns":[]}}
|
Sample No Data Response (XML)
| Code Block | ||||
|---|---|---|---|---|
| ||||
<report> <performance> <startDate>2018-09-12</startDate> <endDate>2018-09-12</endDate> <clickCount>0</clickCount> <installCount>0</installCount> <preloadCount>0</preloadCount> <conversionRate>0.0000</conversionRate> <ctr xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:nil="true"/> <spend>0.00</spend> <cpi>0.00</cpi> <tiers/> <countries/> <campaigns/> </performance> </report> |
...