Trading Desk Stats API дозволяє робити запит на витяг статистики як за сутностями в цілому (рекламодавці, кампанії і т.д.), так і за певними метриками (покази, кліки, унікальні користувачі тощо).
Спочатку потрібно отримати токен доступу. Використовуючи Postman чи іншу схожу програму, відправте POST-запит за URL-адресою: https://api.stacksandbox.com/api/token?userName=user&password=pass
Значення | Опис |
---|---|
userName | Ваш логін (email) для входу в акаунт |
password | Пароль до вашого акаунту |
Значення цього поля – ваш токен доступу. Вказуйте його при кожному запиті у хедері запиту у такому вигляді:
Authorization: Bearer your_token
де замість your_token підставляєте свій токен. Наприклад:
Далі отримайте ID сутностей.
Для запиту статистики вам знадобиться ID сутсності.
Сутність | Значення |
---|---|
Advertiser | Позначає реального рекламодавця у системі Admixer |
Campaign | Відповідає одній рекламній кампанії |
Profile | Містить налаштування показу реклами, наприклад, бюджет, інвентар, таргетинг та деталі ставки |
Ad Item | Містить основну інформацію про креатив, дозволяє налаштувати пріоритетність показу креативу і відстеження подій |
Щоб отримати 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 |
Тепер, коли у вас є 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-адресі запиту.
Для вивантаження статистики в URL-адресі запиту потрібно вказати ID сутності/сутностей та період, за який витягуватимуться дані.
Параметр | Опис |
---|---|
ids | ID сутності, по якій вивантажується статистика |
dateFrom | Дата початку періоду, за який вивантажується статистика, згідно з часовим поясом акаунта. Вказується в форматі yyyy-mm-dd |
dateTo | Дата закінчення періоду, за який вивантажується статистика, відповідно до часового поясу облікового запису. Вказується в форматі yyyy-mm-dd |
Щоб отримати статистику по сутності, відправте GET-запит на відповідну URL-адресу.
Сутність | URL-адреса |
---|---|
Advertiser | https://api.stacksandbox.com/api/advertiser/stats?dateFrom=yyyy-mm-dd&dateTo=yyyy-mm-dd¤cyType=TradingDesk&TimeZoneType=TadingDesk |
Campaign | https://api.stacksandbox.com/api/campaign/stats?dateFrom=yyyy-mm-dd&dateTo=yyyy-mm-dd¤cyType=TradingDesk&TimeZoneType=TadingDesk |
Profile | https://api.stacksandbox.com/api/profile/stats?dateFrom=yyyy-mm-dd&dateTo=yyyy-mm-dd¤cyType=TradingDesk&TimeZoneType=TadingDesk |
Ad Item | ttps://api.stacksandbox.com/api/ad-item/stats?dateFrom=yyyy-mm-dd&dateTo=yyyy-mm-dd¤cyType=TradingDesk&TimeZoneType=TadingDesk |
Вивантажуйте статистику за метриками в рамках профайлу або 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¤cyType=TradingDesk&TimeZoneType=TadingDesk https://api.stacksandbox.com/api/profile/profile_id/stats/region?datefrom=yyyy-mm-dd&dateto=yyyy-mm-dd¤cyType=TradingDesk&TimeZoneType=TadingDesk |
Domain | https://api.stacksandbox.com/api/profile/profile_id/stats/domain?datefrom=yyyy-mm-dd&dateto=yyyy-mm-dd¤cyType=TradingDesk&TimeZoneType=TadingDesk |
Device Type | https://api.stacksandbox.com/api/profile/profile_id/stats/device-type?datefrom=yyyy-mm-dd&dateto=yyyy-mm-dd¤cyType=TradingDesk&TimeZoneType=TadingDesk |
OS | https://api.stacksandbox.com/api/profile/profile_id/stats/os?datefrom=yyyy-mm-dd&dateto=yyyy-mm-dd¤cyType=TradingDesk&TimeZoneType=TadingDesk |
Замініть в URL-адресі значення profile_id на ID профайлу та вкажіть дати початку (datefrom) та закінчення (dateto) періоду, за який вивантажується статистика.
Щоб отримати статистику за метриками в рамках 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¤cyType=TradingDesk&TimeZoneType=TadingDesk https://api.stacksandbox.com/api/ad-item/ad-item_id/stats/region?datefrom=yyyy-mm-dd&dateto=yyyy-mm-dd¤cyType=TradingDesk&TimeZoneType=TadingDesk |
Domain | https://api.stacksandbox.com/api/ad-item/ad-item_id/stats/domain?datefrom=yyyy-mm-dd&dateto=yyyy-mm-dd¤cyType=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¤cyType=TradingDesk&TimeZoneType=TadingDesk |
OS | https://api.stacksandbox.com/api/ad-item/ad-item_id/stats/os?datefrom=yyyy-mm-dd&dateto=yyyy-mm-dd¤cyType=TradingDesk&TimeZoneType=TadingDesk |
Замініть в URL-адресі значення ad item_id на ID Ad Item та вкажіть дати початку (datefrom) та закінчення (dateto) періоду, протягом якого вивантажується статистика.
Повний список методів для нашого DSP API можна знайти тут: https://api.admixer.net/swagger/index.html.
Будь ласка, авторизуйтеся за допомогою логіна та пароля, натиснувши кнопку Авторизація у верхньому правому куті. Будь ласка, не змінюйте поля client_id і client_secret.