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:

FieldData TypeDescriptionNote
report*StringOne of ["Performance", "Zone-Forecast", "Performance-Hour", "Delivery-Hour"]
filtersObject ArrayList of filter objects to apply to report
columns*Object ArrayList of columns to include in the report
groupBy*StringThe field the report should be grouped onShould be left out for reports that only can be grouped in one way
startDateStringBegin date for the report, inclusive
endDateStringEnd date for the report, inclusive
nameStringA name for the report
    "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 "" | 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