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.
Authentication & Access Token
Step 1: Obtain API access data
Make sure that you have your API access data.
Step 2: Request access token
Send an HTTP POST request to the token endpoint https://api.adup-tech.com/v202101/oauth2/token. Example:
curl -X POST \
https://api.adup-tech.com/v202101/oauth2/token \
-H 'Content-Type: application/x-www-form-urlencoded' \
-d 'grant_type=client_credentials&client_id=YOUR_CLIENT_ID&client_secret=YOUR_CLIENT_SECRET'Parameter:
- grant_type: The type of grant, e.g. client_credentials.
- client_id: Your client ID.
- client_secret: Your client secret.
Step 3: Use access token
After successful authentication, you will receive a response with the access token. You can use this token to access protected resources of the API by including it in the HTTP header of your API requests:
curl -X GET \
https://api.adup-tech.com/v202101/ihre-api-endpoint \
-H 'Authorization: Bearer IHR_ACCESS_TOKEN'Replace IHR_ACCESS_TOKEN with the received token and adjust the URL accordingly.
Additional notes:
- Please note that access tokens have a limited validity period and must be renewed regularly.
- Responses are made in JSON format, further information: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept
- The use of Postman is described here: https://learning.postman.com/docs/sending-requests/authorization/oauth-20/#using-client-credentials
{
"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 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.
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.