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

Время действия токена - 24 часа.

Запрос - https://api.hybrid.ru/token (POST)

Параметры

Header

Content-Type: string application/x-www-form-urlencoded

Body

grant_type: string client_credentials

client_id: string {client_id}

client_secret: string {client_secret}

Responses
200 Successfully retrieved.

{
"access_token": "lXe7ahBEgf_iPhgxRloCsgVpn2DcME- 5_gd6gZl2j5h7Hzk4GFgICfiNy4GUuha1F53jqDRs1uD5NYGuSeBxus0tz_5ZBZ4UUhjjmki0i4j-jwYnYqDealRm194Fcz6mjy2gx3peFKp8L604Rk0Fg17R7XAhflLhaH9wt_Yqw2ndSkhEOEQEXmrs6A1U3i9KgLc0LDepwdoQqvx2LPG7QfD3KmAo",
"token_type": "bearer",
"expires_in": 86399,
"refresh_token": "FAj7rPtfTAWec9P7LJnbD0v_dxvGEPRa_kvJnGBfwF3TyrMjjHRVuBJxlopG7ArP2Cf0-PxnEELzlrMutXosDDSRwgTj54ruJsdfsDd--E728erG3oAhjpJ0jjgW_mjDQvKVMkRpu2lkr3qUdJouW8nebNOG6w-pxERzwCeiCOCKJ1wjTTy5Ktjr2hVNbEbpL9k-8xz4jAu6Zz-6k8h7"
}

Чтобы получить новый токен, обратитесь к своему персональному менеджеру.

Запрос нового токена

Запрос - https://api.hybrid.ru/token (POST)

Параметры

Header

Content-Type: string application/x-www-form-urlencoded

Body

refresh_token string {refresh_token}

client_secret: string {client_secret}

client_id: string {client_id}

grant_type: string client_credentials

Responses
200 Successfully retrieved.

{
"access_token": "4gq5X9SBZlyHZDVZjGoplR-TIccCB4I5cWtEbEL5YFue5jNEdfsdsfsd31345FFpoa2RpHFf61yrJN2ygNDusQEtTjVpB2ehC44nGJhGUisUpxlQ6grzl0excbQN1Gi5TirPbEltlaQ0kM3fzmrMAiAuoU",
"token_type": "bearer",
"expires_in": 86399,
"refresh_token": "OY1DQynUMwNs5vyeiyxr7ocQPnEynd-RQJJ3lPmp2xxXXUU8TWtO_RMCiyokOobRZgJXsUEOKLMu3nfjJJvL6c979lUg1WKKGv5eNoSQ4x63wW-KsrJDhjUaZuV9PUhjUVyViwH83FLHjF_pmmJY8m0-SQkvyZmAzA9WdXtkeVKdZBwxA5uO01r4gVwpTluqp8_XYZDePjixW-D2W7q1IhbkaJyS"
}

Запрос списка AppObjects для указанной учетной записи

Запрос - https://api.hybrid.ru/v3.0/agency/advertisers (GET)

Параметры

Header

Authorization string Bearer {access_token}

Responses
200

{
"Id": "5f742dd47bc72f3ce4dsd040",
"Name": "advertiser1"
},
{
"Id": "5e3552dskqe35fdsac7c8432",
"Name": "advertiser2"
}

Запрос списка кампаний для указанного объекта AppObject

Запрос - https://api.hybrid.ru/v3.0/advertiser/campaigns?advertiserId={advertiserId} (GET)

advertiserId — AppObjectID

Параметры

Header

Authorization string Bearer {access_token}

Responses
200

{
"Id": "5e37csd47bc72f3ce4dsd040",
"Name": "campaign1"
},
{
"Id": "5e3552dsdbc72fdsac7c8432",
"Name": "campaign2"
}

Запрос списка баннеров для указанной кампании

Запрос - https://api.hybrid.ru/v3.0/campaign/banners?campaignId={campaignId} (GET)

campaignId — id of a campaign

Параметры

Header

Authorization string Bearer {access_token}

Responses
200 id - banner id

{
"Id": "5e354scc7bc72fc4ac7ca0d8",
"Name": "banner2"
},
{
"Id": "5e35fgcc7bc72fc4ac7ca15b",
"Name": "banner2"
}

Запрос статистики для указанного аккаунта

Запрос - https://api.hybrid.ru/v3.0/agency/{split}?from={from}&to={to}&page={page}&limit={limit} (GET)

split — поле группировки, см. раздел "описание группировок и полей" (обязательный параметр)

from — начала запрашиваемого периода (обязательный параметр)

to — окончание запрашиваемого периода(обязательный параметр)

page — номер страницы, начиная с 0 (по умолчанию 0)

limit — количество строк на странице (по умолчанию 100)

Параметры

Header

Authorization string Bearer {access_token}

Responses
200

{
"Statistic": [
{
"Day": "2020-01-15T00:00:00",
"ImpressionCount": 2778927,
"ClickCount": 17704,
"Reach": 1225059,
"CTR": 0.63708042708570611
},
{
"Day": "2020-01-16T00:00:00",
"ImpressionCount": 2388928,
"ClickCount": 15249,
"Reach": 1040949,
"CTR": 0.63831978192729122
}
],
"Total": {
"ImpressionCount": 5167855,
"ClickCount": 32953,
"Reach": 2135812,
"CTR": 0.63765333973186167
}
}

Запрос статистики по определенному AppObject

Запрос - https://api.hybrid.ru/v3.0/advertiser/{split}?from={from}&to={to}&advertiserId={advertiserId}&page={page}&limit={limit} (GET)

split — поле группировки, его также можно посмотреть в разделе "описание группировок и полей" (является обязательным параметром, если токен имеет тип "агентство", если токен имеет тип "рекламодатель", то параметр является ОПЦИОНАЛЬНЫМ)

advertiserId — идентификатор AppObject (обязательный параметра)

from — начала запрашиваемого периода (обязательный параметр)

to — окончание запрашиваемого периода(обязательный параметр)

page — номер страницы, начиная с 0 (по умолчанию 0)

limit — количество строк на странице (по умолчанию 100)

Параметры

Header

Authorization string Bearer {access_token}

Responses
200

{
"Statistic": [
{
"Day": "2020-02-02T00:00:00",
"ImpressionCount": 201618,
"ClickCount": 315,
"Reach": 40211,
"CTR": 0.15623605035264707
},
{
"Day": "2020-02-03T00:00:00",
"ImpressionCount": 105378,
"ClickCount": 278,
"Reach": 27368,
"CTR": 0.26381218091062653
}
],
"Total": {
"ImpressionCount": 306996,
"ClickCount": 593,
"Reach": 64875,
"CTR": 0.1931621258908911
}
}

Запрос статистики по определенной кампании

Запрос - https://api.hybrid.ru/v3.0/campaign/{split}?from={from}&to={to}&campaignId={campaignId}&page={page}&limit={limit} (GET)

split — поле группировки, его также можно посмотреть в разделе "описание группировок и полей" (обязательный параметр)

campaignId — идентификатор кампании (обязательный параметр)

from — начала запрашиваемого периода (обязательный параметр)

to — окончание запрашиваемого периода(обязательный параметр)

page — номер страницы, начиная с 0 (по умолчанию 0)

limit — количество строк на странице (по умолчанию 100)

Параметры

Header

Authorization string Bearer {access_token}

Responses
200

{
"Statistic": [
{
"Day": "2020-02-02T00:00:00",
"ImpressionCount": 12054,
"ClickCount": 0,
"Reach": 330,
"CTR": 0.0
},
{
"Day": "2020-02-03T00:00:00",
"ImpressionCount": 12082,
"ClickCount": 0,
"Reach": 188,
"CTR": 0.0
}
],
"Total": {
"ImpressionCount": 24136,
"ClickCount": 0,
"Reach": 518,
"CTR": 0.0
}
}

Описание группировок и полей

Группировки (splits):

Day — по дням

Hour — по часам

BannerName — по названию креатива

Campaign — по кампаниями

App — по приложениям

DeviceType — по типу устройства

OS — по типу операционной системы (iOS/Android)

OS version — по версии операционной системы

Advertiser — по идентификатору приложения (AppObject id)

Country — по стране

Region — по региону (штату)

City — по городу

BannerSize — по размеру креатива

BannerType — по типу креатива

Ssp — по названию рекламной сети

Week — по неделям

Month — по месяцам

Folder — по группам кампаний (папкам)

Получаемые данные (fields):

ImpressionCount — количество показов

ViewCount — количество просмотров

ClickCount — количество кликов

FirstQuartileEventsCount — просмотры видео на 25%

MidpointEventsCount — просмотры видео на 50%

ThirdQuartileEventsCount — просмотры видео на 75%

CompleteEventsCount — просмотры видео на 100%

Reach — Охват

CPI — стоимость установки

ECPM — Effective CPM

ECPC — Effective CPC

CTR — Click-Through-Rate

Viewability — Процент просматриваемости объявления

Frequency — Частота показов

WinsCount — Количество выигранных аукционов

WinRate — Win Rate (Победы в аукционе/Количество ставок)

ClearRate — Clear Rate (Показы/Количество ставок)

SurvivalRate — Survival Rate (Показы/Количество побед в аукционе)

CTI — Click to Install Rate (Установки/Клики)

CT — Количество установок атрибуцированных по клику

VT — Количество установок атрибуцированных по показу

TotalInstalls — Общее количество установок

Revenue — Доход

ROAS — ROAS

IPM — Installs per Mille (Количество установок на 1000 показов)

VTR — View-Through-Rate

SumWinningPrice — общая стоимость

Для получения дополнительных размеров и полей обратитесь к своему менеджеру или напишите по адресу [email protected].