Report Creation

Each report creation request consist of a POST request containing JSON-formatted information about the requested report to the report endpoint. If successful, a report creation request will return a report ID. This ID can sequently be used to retrieve report results.

The reporting service can run several report requests in parallel.

There are several reports available and each report provide different metrics, filtering and grouping options. Available fields include the following:

Field

Data Type

Description

Note

report*

String

One of ["Performance", "Zone-Forecast", "Performance-Hour", "Delivery-Hour"]

filters

Object Array

List of filter objects to apply to report

columns*

Object Array

List of columns to include in the report

groupBy*

String

The field the report should be grouped on

Should be left out for reports that only can be grouped in one way

startDate

String

Begin date for the report, inclusive

endDate

String

End date for the report, inclusive

name

String

A name for the report

{
    "report":"Performance",
    "filters":[{"advertiser": 1}],
    "startDate": "2018-01-01",
    "endDate": "2018-01-31",
    "groupBy": "campaign",
    "columns":["impressions", "clicks", "ctr", "cost", "saleSum"],
    "name":"Performance Report"
}
curl -H "Content-Type: application/json" -b cookies -c cookies --data-binary @report-data.json -X POST "http://asx-api.bidtheatre.com/v2.0/api/9/report" | jsonpp

{
    "apiVersion": 2,
    "code": 201,
    "method": "POST",
    "report": {
        "reportName": "Performance",
        "aggregationDate": null,
        "name": "Example Report",
        "reportStatus": "pending",
        "id": 3592725,
        "groupBy": "campaign",
        "creationDate": "2018-02-15 13:18:32.497"
    },
    "networkId": 9
}