Basics of the AdUp API

Overview

With our AdUp API, you can sit back and automatically transfer all your account data into your preferred BI system.

Procedure

In advance

To be able to use the AdUp API, create an access account. To do this, go to Profile in your account or read more in the corresponding support article.

Step 1

Obtain your API login details (e.g. via the frontend).

Step 2

Get an access token from the API via OAUTH.

Step 3

Now use the access token to access the reports route. Have a look at the interactive documentation for this.

Step 4

Then set up your personal API requests. You will find code examples, a description of all fields, as well as notes and links to all possible reports further down in this article. 

Report Request

Code

{
  "report_name": "Test Report",
  "report_type": "CAMPAIGN_PERFORMANCE_REPORT",
  "select": [
    "Month",
    "CampaignName",
    "Clicks"
  ],
  "conditions": [
    {
      "field": "Clicks",
      "operator": "GREATER_THAN",
      "values": [
        "0"
      ]
    }
  ],
  "download_format": "JSON",
  "date_range_type": "LAST_MONTH"

{
  "report_name": "Test Report",
  "report_type": "CAMPAIGN_PERFORMANCE_REPORT",
  "select": [
    "Month",
    "CampaignName",
    "Clicks"
  ],
  "conditions": [
    {
      "field": "Clicks",
      "operator": "GREATER_THAN",
      "values": [
        "0"
      ]
    }
  ],
  "download_format": "JSON",
  "date_range_type": "LAST_MONTH"

{
  "report_name": "Test Report",
  "report_type": "CAMPAIGN_PERFORMANCE_REPORT",
  "select": [
    "Month",
    "CampaignName",
    "Clicks"
  ],
  "conditions": [
    {
      "field": "Clicks",
      "operator": "GREATER_THAN",
      "values": [
        "0"
      ]
    }
  ],
  "download_format": "JSON",
  "date_range_type": "LAST_MONTH"

Notes

Segmentation

To get statistics with a higher level of detail, you can use segmentation.

For example, to get statistics only for mobile devices, you need to filter by device type

In this case, you want to segment your report by DeviceType. For example, if you add the Device field to a Campaign Performance Report, you will get a report with one row for each campaign and device type combination and the statistical values (impressions, clicks, conversions, etc.) split across them. Note that the number of rows can increase exponentially for each additional segment field included in your report.

Implicit segmentation Each report is grouped by a key. For example, the Campaign Performance Report is implicitly segmented by CampaignId.

Rows without metrics

The report may contain rows that do not have values in the metrics. This can be caused by non-deliverable items or items paused within the queried period.

To get rows without metrics, includeZeroImpressions can be set to true (default) in the header. This can be used, for example, to create a structure report that contains all available elements of the account.

However, to reduce the number of rows in the case of many elements without impressions, includeZeroImpressions should be set to false. Alternatively, a filter on metrics in conditions can be used.

Date ranges

For each date_range_type except CUSTOM_DATE, only date_range_type is required.

"date_range": {

    "min": "2021-10-29",

    "max": "2021-10-29"

  },

  "date_range_type": "CUSTOM_DATE"

"date_range": {

    "min": "2021-10-29",

    "max": "2021-10-29"

  },

  "date_range_type": "CUSTOM_DATE"

"date_range": {

    "min": "2021-10-29",

    "max": "2021-10-29"

  },

  "date_range_type": "CUSTOM_DATE"

Data Type Micro Amount

Some fields have the data type Micro Amount, these contain e.g. currency values multiplied by a factor of one million (1,000,000).

Example: A value of EUR 123.4567 is displayed in the field as 123456700.

API Reports

We currently offer four different reports that can be individualised and requested via the API.

Account Performance Report (Advertiser) Documentation

Ad Performance Report (Advertiser) Documentation

Campaign Performance Report (Advertiser) Documentation

Direct Placement Performance Report (Advertiser) Documentation

Placement Layout Performance Report (Publisher) Documentation

Other Scopes and Routes

Have you selected other scopes besides reporting in your API access? To get the appropriate routes and information, contact your AdUp representative or write to us at support(at)adup-tech.com​​​​​​​.