Back to Platform Overview
Glossary
APIs
Statistical APIs
Audience APIs

Trading Desk Stats API allows inquiring statistics by entities in general (advertisers, campaigns, etc.) or by metrics in particular (impressions, clicks, unique users, etc.).

Getting a Token

To begin with, you need to get an access token. Using Postman or similar software, send a POST request by URL https://api.stacksandbox.com/api/token?userName=user&password=pass

Note that the access token expires after 24 hours.
Value Description
userName Your account login (email)
password Password to your account
In response, you’ll receive a JSON with an access_token field.
Expand an example of JSON with an access token
{“access_token”=”WAoAc8VaBdBbNeaqZd_DG7AI243l_e5WNXxTN56RNNfyvRmspx”}

The field’s value is your access token. Specify it in the request header every time you inquire statistics the following way:

Authorization: Bearer your_token

where you replace your_token with your access token. For example:


Next, you get entity IDs.

Requesting Entity IDs

You need an entity ID to request statistics.

Admixer Entities


Entity Description
Advertiser Defines a real advertiser in the Admixer system
Campaign Corresponds to one ad campaign
Profile Contains ad delivery settings, e.g. the budget, inventory, targeting, and bid details
Ad Item Contains main information about the creative, allows to set creative rotation priority and event tracking

Retrieving IDs

To retrieve entity IDs, send a GET request by a corresponding URL.

Entity URL
Advertiser https://api.stacksandbox.com/api/advertiser/list
Campaign https://api.stacksandbox.com/api/campaign/list
Profile https://api.stacksandbox.com/api/profile/list
Ad Item https://api.stacksandbox.com/api/ad-item/list
Expand an example with the response
{6831,6832,6833,6834}

Now that you have entity IDs, you can request information about them and their statistics.

Requesting Entity Information

You can retrieve information about a particular entity (name in the system, state, ad settings, etc.). Send GET request by a corresponding URL.

Entity URL
Advertiser https://api.stacksandbox.com/api/advertiser/advertiser_id
Campaign https://api.stacksandbox.com/api/campaign/campaign_id
Profile https://api.stacksandbox.com/api/profile/profile_id
Ad Item https://api.stacksandbox.com/api/ad-item/ad-item_id

Replace advertiser_id, campaign_id, profile_id, ad Item_id with an advertiser ID, campaign ID, profile ID, or Ad Item ID respectively in your request URL.

Expand an example of the response for the entity request
{
  "Id": 6831,
  "Name": "advertiser",
  "DisplayName": null,
  "State": "Active"
}

Requesting Statistics

You can retrieve statistics by each entity and particular metrics.

Statistics are retrieved according to the time zone set in the advertiser’s account. The interval between requests must be no less than 30 sec.

To receive statistics, specify entity ID or IDs and the period for which the data will be retrieved in the request URL.

Parameter Description
ids ID of an entity by which statistics is retrieved
dateFrom Start date of the period for which statistics is retrieved, according to account’s time zone. Date format yyyy-mm-dd
dateTo End date of the period for which statistics is retrieved, according to account’s time zone. Date format yyyy-mm-dd
The statistical information about Opportunities will be displayed only if the selected period is not less than 3 months.

Statistics by Entities

To retrieve statistics by an entity, send a GET request by the corresponding URL.

Entity URL
Advertiser https://api.stacksandbox.com/api/advertiser/stats?dateFrom=yyyy-mm-dd&dateTo=yyyy-mm-dd&currencyType=TradingDesk&TimeZoneType=TadingDesk
Campaign https://api.stacksandbox.com/api/campaign/stats?dateFrom=yyyy-mm-dd&dateTo=yyyy-mm-dd&currencyType=TradingDesk&TimeZoneType=TadingDesk
Profile https://api.stacksandbox.com/api/profile/stats?dateFrom=yyyy-mm-dd&dateTo=yyyy-mm-dd&currencyType=TradingDesk&TimeZoneType=TadingDesk
Ad Item https://api.stacksandbox.com/api/ad-item/stats?dateFrom=yyyy-mm-dd&dateTo=yyyy-mm-dd&currencyType=TradingDesk&TimeZoneType=TadingDesk
Expand an example of the response for the statistics request
{
  "43497": [
    {
      "Date": "2019-11-05T00:00:00",
      "Uniques": 3773,
      "Clicks": 0,
      "Impressions": 1317,
      "ViewableImpressions": 888,
      "Revenue": 19.7544732,
      "Spends": 19.7544732,
      "InventoryCost": 17.958612
    }
  ]
}
Expand an example of the response to an ad item request (with VAST event statistics)
"111111": [
  {
    "Date": "2021-11-01T00:00:00",
    "Uniques": 1257552,
    "Clicks": 0,
    "Impressions": 38487,
    "ViewableImpressions": 38485,
    "VastQ1": 38334,
    "VastQ2": 38262,
    "VastQ3": 38206,
    "VastEnd": 38203,
    "Revenue": 4717.19838245,
    "Spends": 2620.66576805,
    "DMPCost": 0.0,
    "InventoryFee": 0.0,
    "TechFee": 0.0,
    "CreativeCost": 0.0,
    "ProfileFee": 2096.53261440,
    "DMPFee": 0.0,
    "CreativeFee": 0.0,
    "InventoryCost": 2620.66576805
  },
{

Statistics by Metrics

Retrieve statistics by metrics within a profile or Ad Item.

Within a profile

To receive statistics by metrics within a profile, send a GET request by a corresponding URL.

Metrics URL

Country/Region
 https://api.stacksandbox.com/api/profile/profile_id/stats/country?datefrom=yyyy-mm-dd&dateto=yyyy-mm-dd&currencyType=TradingDesk&TimeZoneType=TadingDesk
https://api.stacksandbox.com/api/profile/profile_id/stats/region?datefrom=yyyy-mm-dd&dateto=yyyy-mm-dd&currencyType=TradingDesk&TimeZoneType=TadingDesk
Domain https://api.stacksandbox.com/api/profile/profile_id/stats/domain?datefrom=yyyy-mm-dd&dateto=yyyy-mm-dd&currencyType=TradingDesk&TimeZoneType=TadingDesk
Device Type https://api.stacksandbox.com/api/profile/profile_id/stats/device-type?datefrom=yyyy-mm-dd&dateto=yyyy-mm-dd&currencyType=TradingDesk&TimeZoneType=TadingDesk
OS https://api.stacksandbox.com/api/profile/profile_id/stats/os?datefrom=yyyy-mm-dd&dateto=yyyy-mm-dd&currencyType=TradingDesk&TimeZoneType=TadingDesk 
Replace Profile_id in URL with a profile ID and specify the start date (datefrom) and end date (dateto) of the period for which the statistics are retrieved.

Expand an example of the response for the statistics request within a profile
{
  "113873": [
    {
      "Date": "2019-03-29T00:00:00",
      "Uniques": 23,
      "Clicks": 126,
      "Impressions": 13236,
      "ViewableImpressions": 13236,
      "Revenue": 9.0415116,
      "Spends": 9.0415116,
      "InventoryCost": 9.0415116,
      "DeviceType": "Phone"
     }
  ]
}

Within an Ad Item

To receive statistics by metrics within an Ad Item, send a GET request by a corresponding URL.

Metrics URL

Country/Region
 https://api.stacksandbox.com/api/ad-item/ad-item_id/stats/country?datefrom=yyyy-mm-dd&dateto=yyyy-mm-dd&currencyType=TradingDesk&TimeZoneType=TadingDesk
https://api.stacksandbox.com/api/ad-item/ad-item_id/stats/region?datefrom=yyyy-mm-dd&dateto=yyyy-mm-dd&currencyType=TradingDesk&TimeZoneType=TadingDesk
Domain https://api.stacksandbox.com/api/ad-item/ad-item_id/stats/domain?datefrom=yyyy-mm-dd&dateto=yyyy-mm-dd&currencyType=TradingDesk&TimeZoneType=TadingDesk
Device Type https://api.stacksandbox.com/api/ad-item/ad-item_id/stats/device-type?datefrom=yyyy-mm-dd&dateto=yyyy-mm-dd&currencyType=TradingDesk&TimeZoneType=TadingDesk
OS https://api.stacksandbox.com/api/ad-item/ad-item_id/stats/os?datefrom=yyyy-mm-dd&dateto=yyyy-mm-dd&currencyType=TradingDesk&TimeZoneType=TadingDesk
Replace in the URL ad item_id with an Ad Item ID and specify the start date of the period for which the statistics are retrieved.
Expand an example of the response for the statistics request within an ad item
{
  "235909": [
    {
      "Date": "2019-11-04T00:00:00",
      "Uniques": 12,
      "Clicks": 358,
      "Impressions": 1975,
      "ViewableImpressions": 745,
      "Revenue": 29.62421,
      "Spends": 29.62421,
      "InventoryCost": 26.9311,
      "PlatformName": "IPhone"
    }
  ]
}
Full list of methods for our DSP API can be found here: https://api.admixer.net/swagger/index.html

Please Authorize with your login and password by clicking on the Authorization button in the upper right corner. Please do not change the client_id and client_secret fields.
Updated on September 25, 2023