AdUp API basics

Procedure

In advance

To use the AdUp API, create an account. To do this, go to Profile in your account or read the relevant support article.

Step 1

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

Step 2

Obtain an access token from the API via OAUTH.

Step 3

Now use the access token to access the reports route. Take a look at the interactive documentation.

Step 4

Then set up your personal API requests. You can find code examples, descriptions of all fields as well as hints 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"
}

Field	Description	Example
report_name	Self-selected name of the report.
report_type	The report type to be used for the report. See 'API Reports' below
select	List of fields to be output in the report. The possible fields depend on the type of report used. See 'API Reports' below for the possible fields.
conditions	List of filters to limit the rows contained in the report. A filter consists of field, operator and values
download_format	Format in which the report is downloaded. Currently only JSON is possible
date_range_type	The date range for which the report is to be created. See 'Date ranges' below
date_range	If date_range_type has been set to CUSTOM_DATE, this specifies here the date range for which the report is to be created. See 'Date ranges' below

Notes

Segmentation

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

For example, to get statistics for mobile devices only, 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 between 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 have no values in the metrics. This may be due to undeliverable items or items paused within the queried time period.

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

However, to reduce the number of rows with many elements without, 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	Reports are created for...	Example
TODAY	Today only
YESTERDAY	only yesterday
LAST_7_DAYS	the last 7 days without today
LAST_WEEK	the 7-day period starting from the last Monday
LAST_BUSINESS_WEEK	the 5-day business week, Monday to Friday, of the last business week
THIS_MONTH	all days of the current month
LAST_MONTH	all days of the last month
ALL_TIME	The entire available period
CUSTOM_DATE	A period of your own. See Own time period.	`"date_range": { "min": "2021-10-29", "max": "2021-10-29" }, "date_range_type": "CUSTOM_DATE"`
LAST_14_DAYS	the last 14 days without today
LAST_30_DAYS	the last 30 days without today
THIS_WEEK_SUN_TODAY	the period between last Sunday and today
THIS_WEEK_MON_TODAY	the period between last Monday and today
LAST_WEEK_SUN_SAT	the 7-day period beginning with the last Sunday

Datentyp 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 123.4567 EUR is displayed in the field as 123456700.

API Reports

We currently offer four different reports that can be accessed individually via the API.

Account Performance Report (Advertiser) Documentation

Ad Performance Report (Advertiser) Documentation

Campaign Performance Report (Advertiser) Documentation

Direct Placement Performance Report (Advertiser) Dokumentation

Placement Layout Performance Report (Publisher) Documentation

Other scopes and routes

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

Basics of the AdUp API