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](#step-1-obtaining-the-access-token-0-2) 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](https://app.gitbook.com/s/LbREhkP3WlLtP6TNVZ2Q/reports/using-the-reports).
#### **URL**
```
https://reporting.fyber.com/api/v1/report?format=csv
```
#### **Headers**
{% code overflow="wrap" %}
```
ContentType: application/json
Authorization: Bearer
```
{% endcode %}
#### **Params**
```
format csv
```
#### **Body. raw (application/json)**
{% code title="JSON" %}
```json
{
"source": "mediation",
"dateRange": {
"start": "2019-07-01",
"end": "2019-09-25"
},
"metrics": [\
"Bid Requests",\
"Bid Responses",\
"Impressions",\
"Clicks",\
"Rewarded Completions",\
"Revenue (USD)",\
"Unique Impressions"\
],
"splits": [\
"Fyber App ID"\
],
"filters": [\
{\
"dimension": "Country",\
"values": [\
"US",\
"CA",\
"RU"\
]\
}\
]
}
```
{% endcode %}
If no splits or filters are required, their value should be an empty array. However, source, dateRange and metrics must include a value.
{% code title="JSON" %}
```json
{
"source": "mediation",
"dateRange": {
"start": "2019-06-01",
"end": "2019-09-25"
},
"metrics": [\
"Bid Requests"\
],
"splits": [],
"filters": []
}
```
{% endcode %}
### **Responses**
Set out below are examples of both successful and unsuccessful responses.
#### **Response: Successful**
{% code title="JSON" overflow="wrap" %}
```json
{
"id": "XXXXXXXX-25db-4af0-8988-1e7d8e6d90bc",
"url": "https://fyber-async-reports.s3.amazonaws.com/group%3D210263/XXXXXXXX-25db-4af0-8988-1e7d8e6d90bc.csv?AWSAccessKeyId=AKIAQBQNZ5FYXXXXXXXX&Expires=1570020564&Signature=LbhE5uljlPEKQRTbepDqmDXXXXXXXX",
}
```
{% endcode %}
* 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**
{% code title="JSON" %}
```json
{
"error": "invalid_token"
}
```
{% endcode %}
### **Possible Errors**
The table below shows the main errors indicating an unsuccessful response.
| HTTP Status Code | Error | Description (optional) | Scenario |
| ---------------- | ----------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| 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:
1. Receive the URL from the successful response in [Step 2](#section-step-2-reporting-api-request).
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.
3. 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](#section-step-2-reporting-api-request).
* 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](#supported-metrics-and-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](https://app.gitbook.com/s/LbREhkP3WlLtP6TNVZ2Q/reports/demand-performance#demand-performance-metrics).
| Source | Supported 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](https://app.gitbook.com/s/LbREhkP3WlLtP6TNVZ2Q/reports/demand-performance#demand-performance-dimensions).
| Source | Supported 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](https://app.gitbook.com/s/LbREhkP3WlLtP6TNVZ2Q/reports/user-activity#user-activity-metrics).
| Source | Supported Metrics |
| ------ | ----------------- |
| dau | Revenue (USD) |
| | Unique Users |
| | ARPDAU |
#### Dimensions
For descriptions of the dimensions in the DAU report, see [User Activity Dimensions](https://app.gitbook.com/s/LbREhkP3WlLtP6TNVZ2Q/reports/user-activity#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.