Reporting API
This guide is intended for Advertisers using DT Offer Wall Reporting API.
This Reporting API enables you to access all the reporting data related to monetization of your DT Offer Wall. You can query multiple metrics such as revenue and impressions across the available dimensions and even implement filters.
For supported metrics and dimensions for Advertisers, see DT Offer Wall Report Dimensions for Advertisers.
DT Offer Wall 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 create a custom report as described in Step 2. A successful response will contain a URL leading to a file that will be populated with the custom report. More details can be found in Step 3.
Step 1: Obtaining the Access Token
DT'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 DT Console.
On the left menu bar, click Users.
Click User Profile to display the Reporting API Keys.
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 to receive new credential.
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: https://reporting.fyber.com
Authentication Token
Headers
Sample Request
Params
Body: raw (application/json)
Grant Type must be "client_credentials". 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:
Successful Response
accessToken: The token required to continue the process tokenType: Bearer expiresIn: 3600 seconds (1 hour)
When a request is unsuccessful, you receive the following response:
Unsuccessful Response
Possible Authentication Errors
Set out in the table are a list of possible errors which resulted in an unsuccessful response.
400
unsupported_grant_type
Invalid grant type
400
invalid_request
When there are missing credentials
400
invalid_client
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.
500
internal_server_error
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 request is made up of five individual sections:
Source
Date Range
Metrics
Splits
Filters (include)
Request Example
Source
The below is an example from the DT Offer Wall report. The source can either "performance" or "event" - depending on the view you want to see.
Performance based view. Every action/revenue metric, is attributed to the time of the click and impression. This view allows a clear understanding of how your manipulations impact performance.
Event based view (Billing). Every action/revenue metric is attributed to the time it happened. This view allows a clear understanding of the periodical revenues conversions and other events, as they happened. This data pulled from this view matches your monthly billed invoice.
Source must be in lower case.
Date Range
Start date: 2019-01-06 End date: 2019-09-25
Metrics
Advertiser Spend
Advertiser ARPU
Offer Impressions
Offer Clicks
Splits (dimensions)
Country
Filters
Dimension filtered is the country
Values filtered are US, CA and RU
For a full list of supported Metrics and Dimensions per report, see Supported Metrics and Dimensions.
For further descriptions about the terms used in this article, see Using the Reports.
URL
Headers
Params
Body. raw (application/json)
If no splits or filters are required, their value should be an empty array. However, source, dateRange and metrics must include a value.
For example:
Responses
Set out below are examples of both successful and unsuccessful responses.
Response: Successful>
The "id" field holds an identifier of the request for later troubleshooting, if required.
The "url" field holds the URL to be polled (GET request) until the body response (file) is populated.
Response: Unsuccessful
Possible Errors
The table below shows the main errors indicating an unsuccessful response.
401
invalid_token
Invalid authorization token
Authorization header is empty Authorization header not sent or token is not present in the header Unrecognized token Disabled account
400
invalid_format
Invalid file format requested
Format is not supported - currently only csv format is supported
400
invalid_query
For example: Invalid value undefined supplied to : Query/dateRange: DateRange -or- Invalid value "XXXXX" supplied to : Query/dateRange: DateRange/end: Date -or- Invalid dimensions: A,B,C -or- Invalid metrics: A,B,C
If the query sent is not in the expected schema Date range is not sent in the ISO 8601 format. -or- Invalid dimensions You do not have the user permission to query a dimension. -or- Invalid metrics You do not have the user permission to query a metric.
400
invalid_source
Invalid source: XXXXX
Unsupported source type
500
internal_server_error
Unexpected errors in DT's servers
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.
Perform polling on the URL to access the file containing the custom report. The empty file is populated within one hour, depending on the size of the query.
If the file is not populated with data after one hour, resend the request.
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.
General
All reports are presented in US dollars.
The time zone used is UTC.
The Reporting APIs are available on a daily level, with a delay of up to 12 hours from the end of day UTC.
Query Restrictions
All fields are mandatory. Splits and Filters can have an empty array. See example in Step 2.
The time range for a report query is limited to 90 days.
Queries are limited to a maximum of 50 per day, per API.
You can query each one of the defined dimensions in the Reporting API calls by up to 5 dimensions in a single query.
To receive a breakdown by date, it must exist in the "splits" array.
Date Range Restrictions
There are a number of rules that must be observed with regard to the date range:
The start date and end date must be in the format of ISO 8601. For example, 2019-10-03.
The interval between the start and end date should not exceed 90 days.
The start date must be earlier or equal to the end date.
The start date must be no later than the previous 18 months.
The end date can not be a date beyond the current date.
The start and end dates are from midnight to midnight.
Data for DT Offer Wall Reports is available from 10 June 2019 onwards. Queries with the current day's date or dates prior to the above time periods result in an HTTP 400 status code (invalid_query).
Last updated