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 |
Теперь, когда у вас есть идентификаторы сущностей, вы можете запросить информацию о них и их статистику.
Вы можете получить информацию о конкретной сущности (имя в системе, статус, настройки показа и т.д.). Для этого отправьте 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 соответственно.
Для выгрузки статистики в 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 | https://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?amp;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?amp;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?amp;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.