Getting a token
Token lifetime - 24 hours.
Request - https://api.hybrid.ru/token (POST)
Parameters
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"
}
To get a new token, please contact your personal manager.
Getting a new token
Request - https://api.hybrid.ru/token (POST)
Parameters
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"
}
Receiving a list of AppObjects for a specified account
Request - https://api.hybrid.ru/v3.0/agency/advertisers (GET)
Parameters
Header
Authorization string Bearer {access_token}
Responses
200
{
"Id": "5f742dd47bc72f3ce4dsd040",
"Name": "advertiser1"
},
{
"Id": "5e3552dskqe35fdsac7c8432",
"Name": "advertiser2"
}
Receiving a list of campaigns for a specified AppObject
advertiserId — AppObjectID
Parameters
Header
Authorization string Bearer {access_token}
Responses
200
{
"Id": "5e37csd47bc72f3ce4dsd040",
"Name": "campaign1"
},
{
"Id": "5e3552dsdbc72fdsac7c8432",
"Name": "campaign2"
}
Receiving a list of banners for a specified campaign
campaignId — id of a campaign
Parameters
Header
Authorization string Bearer {access_token}
Responses
200 id - banner id
{
"Id": "5e354scc7bc72fc4ac7ca0d8",
"Name": "banner2"
},
{
"Id": "5e35fgcc7bc72fc4ac7ca15b",
"Name": "banner2"
}
Getting statistics for the specified account
Request - https://api.hybrid.ru/v3.0/agency/{split}?from={from}&to={to}&page={page}&limit={limit} (GET)
split — the grouping field, see the section description of groupings and fields (required parameter)
from — the lower threshold of the statistics date (required parameter)
to - upper threshold of the statistics date (required parameter)
page — page number starting from 0 (default is 0)
limit — number of lines per page (100 by default)
Parameters
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
}
}
Getting statistics for the specified AppObject
Request - https://api.hybrid.ru/v3.0/advertiser/{split}?from={from}&to={to}&advertiserId={advertiserId}&page={page}&limit={limit} (GET)
split — the grouping field, you can also see it the section "description of groupings and fields" (is a mandatory parameter if the token is of the "agency" type, if the token is of the "advertiser" type, the parameter is OPTIONAL)
advertiserId — AppObject id (required parameter)
from — the lower threshold of the statistics date (required parameter)
to — upper threshold of the statistics date (required parameter)
page — page number starting from 0 (default is 0)
limit — number of lines per page (100 by default)
Parameters
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
}
}
Getting statistics for the specified campaign
Request - https://api.hybrid.ru/v3.0/campaign/{split}?from={from}&to={to}&campaignId={campaignId}&page={page}&limit={limit} (GET)
split — the grouping field, you can also see it the section "description of groupings and fields" (required parameter)
campaignId — campaign id (required parameter)
from — the lower threshold of the statistics date (required parameter)
to — upper threshold of the statistics date (required parameter)
page — page number starting from 0 (default is 0)
limit — number of lines per page (100 by default)
Parameters
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
}
}
Description of groupings and fields
Groupings (splits):
Day — by days
Hour — by hours
BannerName — by creative names
Campaign — by campaigns
App — by apps
DeviceType — by device types
OS — by OS type
OS version — by OS version
Advertiser — by AppObject id
Country — by country
Region — by region (state)
City — by city
BannerSize — by creative size
BannerType — by creative type
Ssp — by the name of the advertising network
Week — by weeks
Month — by months
Folder — by campaign groups (folders)
Received statistics fields (fields):
ImpressionCount — Number of impressions
ViewCount — Number of views
ClickCount — Number of clicks
FirstQuartileEventsCount — Video views by 25%
MidpointEventsCount — Video views by 50%
ThirdQuartileEventsCount — Video views by 75%
CompleteEventsCount — Video views by 100%
Reach — Reach
CPI — Cost Per Install
ECPM — Effective CPM
ECPC — Effective CPC
CTR — Click-Through-Rate
Viewability — The percentage of viewability of the ad
Frequency — Frequency of impressions
WinsCount — Number of auction wins
WinRate — Win Rate (Wins/Bids)
ClearRate — Clear Rate (Impressions/Bids)
SurvivalRate — Survival Rate (Impressions/Wins)
CTI — Click to Install Rate (Installs/Clicks)
CT — Number of click-through installs
VT — Number of view-through installs
TotalInstalls — Total Number of Installs
Revenue — Revenue
ROAS — ROAS
IPM — Installs per Mille (Installs per 1 000 Impressions)
VTR — View-Through-Rate
SumWinningPrice — Total cost
For additional dimensions and fields, contact your manager or write to [email protected].