Admixer HelpCenter

Ukrainian

English

Russian

Назад до Огляду платформи

Глосарій

API

Статистичні APIs

Audience APIs

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}

Тепер, коли у вас є ID сутностей, ви можете робити запит на інформацію про них та статистику.

Ви можете отримати інформацію про конкретну сутність (ім'я в системі, статус, налаштування показу тощо). Для цього надішліть 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

Замініть advertiser_id, campaign_id, profile_id, ad item_id на ID рекламодавця, ID кампанії, ID профілю або Ad Item ID відповідно в URL-адресі запиту.

Показати приклад відповіді на запит сутностей

{
  "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	ttps://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?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

Замініть в 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