Admixer HelpCenter

Russian

English

Ukrainian

Назад к Обзору платформы

Глоссарий

API

Статистические API

Аудиторные API

Trading Desk Stats API позволяет запрашивать статистику как по сущностям в целом (рекламодатели, кампании и т.д.), так и по определенным метрикам (показы, клики, уникальные пользователи и т.д.).

Получение токена

Для начала нужно получить токен доступа. Используя Postman или другую подобную программу, отправьте POST-запрос по URL-адресу: https://api.stacksandbox.com/api/token?userName=user&password=pass.

Заметьте, что токен доступа истекает через 24 часа.

Значение	Описание
userName	Ваш логин (email) для входа в аккаунт
password	Пароль к вашему аккаунту

В ответ вы получите JSON с полем access_token.

Показать пример JSON-ответа с токеном доступа

{“access_token”=”WAoAc8VaBdBbNeaqZd_DG7AI243l_e5WNXxTN56RNNfyvRmspx”}

Значение этого поля — ваш токен доступа. Указывайте его при каждом запросе в хедере запроса в таком виде:

Authorization: Bearer your_token

где вместо your_token подставляете свой токен. Например:

Далее получите ID сущностей.

Для запроса статистики вам понадобится ID сущности.

Сущности Admixer

Сущность	Значение
Advertiser	Обозначает реального рекламодателя в системе Admixer
Campaign	Соответствует одной рекламной кампании
Profile	Содержит настройки показа рекламы, например бюджет, инвентарь, таргетинг и детали ставки
Ad Item	Содержит основную информацию о креативе, позволяет настроить приоритетность показа креатива и отслеживание событий

Получение ID

Чтобы получить ID сущностей, отправьте GET-запрос по соответствующему URL-адресу.

Сущность	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

Показать пример ответа

{6831,6832,6833,6834}

Теперь, когда у вас есть идентификаторы сущностей, вы можете запросить информацию о них и их статистику.

Вы можете получить информацию о конкретной сущности (имя в системе, статус, настройки показа и т.д.). Для этого отправьте GET-запрос по соответствующему URL-адресу.

Сущность	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

Замените в URL-адресе значение advertiser_id, campaign_id, profile_id, ad Item_id на ID рекламодателя, кампании, профайла или Ad Item соответственно.

Показать пример ответа на запрос сущностей

{
  "Id": 6831,
  "Name": "advertiser",
  "DisplayName": null,
  "State": "Active"
}

Вы можете получить статистику как по каждой из сущностей, так и по определенным метрикам.

Статистика выгружается согласно часовому поясу, указанному в аккаунте рекламодателя. Интервал между запросами должен составлять не менее 30 сек.

Для выгрузки статистики в URL-адресе запроса нужно указать ID сущности/сущностей и период, за который будут вытягиваться данные.

Параметр	Описание
ids	ID сущности, по которой выгружается статистика
dateFrom	Дата начала периода, за который выгружается статистика, согласно часовому поясу аккаунта. Указывается в формате yyyy-mm-dd
dateTo	Дата окончания периода, за который выгружается статистика, согласно часовому поясу аккаунта. Указывается в формате yyyy-mm-dd

Статистическая информация о метрике Opportunities будет отображаться только если выбранный период — не менее 3 месяцев.

Статистика по сущностям

Чтобы получить статистику по сущности, отправьте GET-запрос по соответствующему URL-адресу.

Сущность	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

Показать пример ответа на запрос статистики

{
  "43497": [
    {
      "Date": "2019-11-05T00:00:00",
      "Uniques": 3773,
      "Clicks": 0,
      "Impressions": 1317,
      "ViewableImpressions": 888,
      "Revenue": 19.7544732,
      "Spends": 19.7544732,
      "InventoryCost": 17.958612
    }
  ]
}

Показать пример ответа на запрос ad item (со статистикой VAST событий)

"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
  },
{

Статистика по метрикам

Выгружайте статистику по метрикам в рамках профайла или Ad Item.

В рамках профайла

Чтобы получить статистику по метрикам в рамках профайла, отправьте GET-запрос по соответствующему URL-адресу.

Метрика	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

Замените в URL-адресе значение profile_id на ID профайла и укажите даты начала (datefrom) и окончания (dateto) периода, за который выгружается статистика.

Показать пример ответа на запрос статистики профайла

{
  "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"
     }
  ]
}

В рамках Ad Item

Чтобы получить статистику по метрикам в рамках Ad Item, отправьте GET-запрос по соответствующему URL-адресу.

Метрика	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?amp;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?amp;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?amp;datefrom=yyyy-mm-dd&dateto=yyyy-mm-dd&currencyType=TradingDesk&TimeZoneType=TadingDesk

Замените в URL-адресе значение ad Item_id на ID Ad Item и укажите даты начала (datefrom) и окончания (dateto) периода, за который выгружается статистика.

Показать пример ответа на запрос 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"
    }
  ]
}

Полный список методов для нашего DSP API можно найти здесь: https://api.admixer.net/swagger/index.html.

Пожалуйста, Авторизуйтесь под своим логином и паролем, нажав на кнопку Авторизация в правом верхнем углу. Пожалуйста, не меняйте поля client_id и client_secret.

Обновлено 06 июня, 2024