DT FairBid Reporting API
The DT FairBid Reporting API enables you to access all the reporting data from the monetization ad units. You can query multiple metrics such as revenue and impressions across the available dimensions and even implement filters.
DT currently offers a Reporting API for two different reports:
For supported metrics and dimensions per report, see 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 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
DTs Reporting API uses Access Tokens for authentication purposes. To obtain your Access Token, you must first get your Client ID and Client Secret.
Make a POST request
The base End Point for the entire process is: https://reporting.fyber.com
Authentication Token
POST /auth/v1/tokenHeaders
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 Responses
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
N/A
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
Set out below is a request example, with the following section settings:
Source
mediation (the example is from the Demand Performance report)
Source must be written in lower case.
Date Range
Start date: 2019-01-06
End date: 2019-09-25
Metrics
Bid Requests
Bid Responses
Impressions
Clicks
Rewarded Completions
Revenue (USD)
Unique Impressions [Deprecated]
Splits (dimensions)
Fyber App ID
Filters
Dimension filtered: country
Values filtered: US, CA and RU
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.
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
N/A
Authorization header is empty Authorization header not sent or token is not present in the header Unrecognized token Disabled account
400
invalid_format
N/A
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 Invalid dimensions Invalid metrics
400
invalid_source
Invalid source: XXXXX
Unsupported source type
500
internal_server_error
N/A
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 all the information, restrictions and rules to ensure a successful response.
General
All reports are presented in US dollars
The time zone used is UTC
Data related to mediated networks is re-aggregated twice a day and updated for two weeks retroactively
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 7 dimensions in a single query
You are restricted to 5 filters per 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 cannot be the current day's date or beyond it
The start date and end date are included in the report
Data for Mediation is available from 2019-04-01 onwards
Data for DAU is available from 2019-08-08 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)
Supported Metrics and Dimensions
You must specify in the API Request the source, metrics, dimensions and optional filters you want to include in your custom report. Currently the sources available are Mediation and DAU.
Mediation
Set out in the tables below are the supported metrics and dimensions available in the Reporting API for the Mediation API.
Metrics
For descriptions of the metrics in the Mediation API, see Demand Performance Metrics.
mediation
Bid Requests
Bid Responses
Impressions
Clicks
Rewarded Completions
Revenue (USD)
Unique Impressions [Deprecated]
Ad Requests
For descriptions of the dimensions in the Mediation API, see Demand Performance Dimensions.
mediation
Date
App Name
App Bundle
Fyber App ID
Placement ID
Placement Name
Placement Type (Available values: Banner, Interstitial, Rewarded)
Country
Device OS (Available values: iOS, Android)
Demand Source Type Name (Available values: Programmatic, Custom API, Programmatic Mediation, Mediated Networks)
Demand Source Name
Daily Active Users (DAU)
Set out in the tables below are the supported metrics and dimensions available in the Reporting API for the DAU Report.
Metrics
For descriptions of the metrics in the DAU report, see User Activity Metrics.
dau
Revenue (USD)
Unique Users
ARPDAU
Dimensions
For descriptions of the dimensions in the DAU report, see User Activity Dimensions.
You can set an include filter on any value(s) within a dimension. This means, all the data presented in the report relates only to the values defined in the filter.
For example:
Dimension = Country
Filtered Value = US or CA
As a result of these filters, the report will contain data relevant only for the countries US and CA.
Last updated