Getting reports

Adfox provides ready-to-use fixed reports for all partners. If you need specific data, you can also use the report builder to design and save your own custom reports right in the interface.

Generating a report involves several steps.

Fixed and custom reports

Generate a report via API

If the report is saved as fixed or custom:

Request a list of reports:
```
GET /api/v2/reports/list
```
Retrieve report parameters (only available for custom reports; it won't return a field list for fixed reports):
```
GET /api/v2/reports/report-info/{reportName}
```
Select the report period:
```
GET /available-dates
```
Send a request to generate the report and save result.taskId:
```
POST /api/v2/reports/{reportName}
```

Retrieve and cache the lists dimensions, metrics, filters, and limits:
```
GET /metadata
```
If needed, retrieve the allowed date range for the report:
```
GET /available-dates
```
Send a request with a valid body and save result.taskId:
```
POST /reports
```

Poll the endpoint until you receive one of the following statuses:
- SUCCESS
- FAILURE
- EXPIRED
```
GET /reports/{taskId}
```
Set a timeout before retrying the request.
When the status is SUCCESS, retrieve the report results:
```
GET /reports/{taskId}/result
```

Was the article helpful?

Authorization

List of fixed and custom reports