The User Level Revenue Reporting API enables you to access reporting data to measure all revenue generated from individual users. This information can be used to optimize retargeting campaigns and accurately measure user lifetime value.
You can query revenue, impressions, clicks and conversion metrics across the available dimensions. For all supported metrics and dimensions for the User Level Reporting API, click the Metrics and Dimensions tab above.
Reporting API Workflow
The publisher makes a POST request using the Client ID and Client Secret to receive the Access Token, as described in Step 1.
Once the request is successful and the Access Token is received, an API Request is made to get a custom report as described in Step 2. A successful response will contain a URL leading to a file containing the custom report. More details can be found in Step 3.
Step 1: Obtaining the Access Token
Digital Turbine's Reporting API uses Access Tokens for authentication purposes. To obtain your Access Token, you must first get your Client ID and Client Secret.
Obtaining your Client ID and Client Secret
- Sign-In to the Console, here
- On the top-left side of the screen, click your User ID
- Click User Profile to display the Reporting API Keys
- If necessary, you can click Revoke to delete the current credentials.
You are returned to the API Keys window.
- Click Generate New Keys again, to receive new credentials.
Keep your Client ID and Client Secret safe, as they can be reused in the future. Using your Client ID and Client Secret make a POST request to receive your Access Token.
The base End Point for the entire process is:
Body: raw (application/JSON)
The credentials are sent according to the OAuth 2.0 Protocol
Sample Authentication Response
When an authentication request is successful, you receive the following response in JSON format:
accessToken:The token required to continue the process
expiresIn:3600 seconds (1 hour)
When a request is unsuccessful, you receive the following response:
Possible Authentication Errors
Set out in the table are a list of possible errors which resulted in an unsuccessful response.
|HTTP Status Code
|When there are missing credentials
|When the credentials are incorrect or cannot be recognized. Can also occur when your account has been disabled or when the credentials have been revoked.
|Unexpected errors in DT's servers
Step 2: Reporting API Request
Use the access token you received in Step 1 to request your custom report.
The only dimension you can query in your Request ID:
All other dimensions always appear in the report.
Below is an example from the User Level Report.
For a full list of supported Metrics and Dimensions per report, click here.
For further descriptions about the terms used in this article, click here.
Make a POST request to receive your report.
Authorization: Bearer [Access Token from Authentication Response]
Set out below are examples of both successful and unsuccessful responses.
The "id" field holds an identifier of the reuest for later troubleshooting, if required.
The "url" field holds the URL to be polled (GET request) to download the custom report
The table below shows the main errors indicating an unsuccessful response.
|HTTP Status Code
|Authorization header is empty Authorization header not sent or token is not present in the header Unrecognized token Disabled account
|For example: Invalid value undefined supplied to : Query/ Date -or- Invalid value "XXXXX" supplied to : Query/ Date
|If the query sent is not in the expected schema
Date range is not sent in the ISO 8601 format
|Error in DT's servers
Step 3: Receiving the Custom Report
To obtain the Custom Report, follow the steps below:
- Receive the URL from the successful response in Step 2
- Click the link. You are reidrected to a CSV file which contains your report.
The URL is valid for three hours.
Additional Information and Restrictions
It is important to take note of the information, restrictions and rules to ensure the reports provided to ensure a successful response.
- All reports are presented in US dollars
- The time zone used is UTC
- The data is available by 12:00 UTC (noon) for the previous 12 days
All dimensions are mandatory
There are a number of rules that must be observed with regard to the date:
- The date must be in the format of ISO 8601. For example, 2019-10-03
- The date is included in the report
Metrics and Dimensions
Set out in the tables below are the supported metrics and dimensions available in the User Level Reporting API.
|Number of times the ad is displayed to the user
|Number of times the use clicked on the offer to complete
|The number of times the user completed the offer
|The total revenue of the publisher in USD coming from the user
|Unique ID in the internal db for the publisher
|Unique ID of the application in the DT system
|Unique ID of the identifier in the DT system
|Original country code of the user
|The identifier of the user supplied by the publisher