Download OpenAPI specification:Download
В случае успеха произойдет перенаправление на страницу, указанную в redirect_uri.
В адрес страницы будет добавлено значение параметра code, необходимое для дальнейшей процедуры получения токена доступа.
| client_id required | string Идентификатор приложения |
| redirect_uri required | string Example: redirect_uri=http://example.com/auth/getuniq Адрес страницы, на которую будет перенаправлен пользователь. Домен адреса должен совпадать с доменом, указанным при регистрации приложения. |
| response_type required | string Value: "code" |
| scope required | string Example: scope=user_info user_accounts Перечисление прав, для которых будет выдан доступ, разделенные пробелом.
|
Получение или обновление ранее выданного токена доступа.
При первом получении токена в параметр grant_type необходимо передать значение authorization_code, а так же передать параметр code, соответствующий полученному аргументу code из предыдущего этапа авторизации.
При обновлении токена в параметр grant_type необходимо передать значение refresh_token, а так же передать параметр refresh_token, полученный при последней авторизации.
| client_id required | string Идентификатор приложения |
| client_secret required | string Секретный ключ вашего приложения |
| grant_type required | string Enum: "authorization_code" "refresh_token" |
| redirect_uri required | string Example: redirect_uri=http://example.com/auth/getuniq Адрес страницы, на которую будет перенаправлен пользователь. Домен адреса должен совпадать с доменом, указанным при регистрации приложения. |
| code | string Код авторизации, полученный на предыдущем шаге |
| refresh_token | string Токен для обновления доступа, полученный при последней авторизации |
{- "access_token": "string",
- "refresh_token": "string",
- "expires_in": 3600,
- "scope": "string"
}Информация о пользователе, от чьего имени был получен токен доступа
| access_token required | string Токен доступа для работы с getUNIQ API |
{- "status": "success",
- "data": {
- "id": 1
}
}| access_token required | string Токен доступа для работы с getUNIQ API |
| status | Array of strings Items Enum: "new" "pending" "verified" "declined" "block" "deleted" "error" |
| limit | integer Example: limit=50 Максимальное количество возвращаемых результатов |
| offset | integer Example: offset=150 Смещение списка возвращаемых результатов |
{- "status": "success",
- "data": [
- {
- "id": 1,
- "status": "new",
- "network_account_id": 1,
- "user": 1,
- "type": "{account_type}",
- "login": "getuniq-u1-1",
- "balance": 1
}
], - "pagination": {
- "offset": 0,
- "limit": 50,
- "total": 10
}
}| access_token required | string Токен доступа для работы с getUNIQ API |
| vk_user_id required | number Идентификатор пользователя ВКонтакте |
required | object |
{- "vk_user_id": 12345678,
- "advertiser_info": {
- "type": "legal",
- "tax_number": "560504123456",
- "phone": "+78005553535",
- "name": "Петров Петя Петрович",
- "contract": {
- "number": "string",
- "date": "2019-08-24",
- "type": "contract",
- "amount": 0,
- "vat_included": true,
- "subject_type": "representation",
- "action_type": "commercial"
}, - "counterparty": {
- "type": "legal",
- "name": "Петров Петя Петрович",
- "tax_number": "560504123456",
- "phone": "+78005553535"
}
}
}{- "status": "success",
- "data": {
- "id": 1,
- "status": "new",
- "network_account_id": 1,
- "user": 1,
- "type": "{account_type}",
- "login": "getuniq-u1-1",
- "balance": 1
}
}| access_token required | string Токен доступа для работы с getUNIQ API |
| firstname required | string Имя пользователя |
| lastname required | string Фамилия пользователя |
| email required | string <email> Email пользователя |
required | object |
{- "firstname": "string",
- "lastname": "string",
- "email": "user@example.com",
- "advertiser_info": {
- "type": "legal",
- "tax_number": "560504123456",
- "phone": "+78005553535",
- "name": "Петров Петя Петрович",
- "contract": {
- "number": "string",
- "date": "2019-08-24",
- "type": "contract",
- "amount": 0,
- "vat_included": true,
- "subject_type": "representation",
- "action_type": "commercial"
}, - "counterparty": {
- "type": "legal",
- "name": "Петров Петя Петрович",
- "tax_number": "560504123456",
- "phone": "+78005553535"
}
}
}{- "status": "success",
- "data": {
- "id": 1,
- "status": "new",
- "network_account_id": 1,
- "user": 1,
- "type": "{account_type}",
- "login": "getuniq-u1-1",
- "balance": 1
}
}| access_token required | string Токен доступа для работы с getUNIQ API |
{- "status": "success",
- "data": {
- "token": "Z5IVgOSMz5GNaNGQVCfQzsxOhNvD8wNbPC4TKKkmVbgsejXoa2Nf...",
- "expires_at": "2019-08-24T14:15:22Z"
}
}| access_token required | string Токен доступа для работы с getUNIQ API |
| date_from | string Example: date_from=2021-05-01 Дата начала периода в формате YYYY-MM-DD |
| date_to | string Example: date_to=2021-05-14 Дата окончания периода в формате YYYY-MM-DD |
| statuses | Array of strings Items Enum: "pending" "paused" "success" "error" "cancelled" "declined" Example: statuses=pending&statuses=error Статусы переводов |
| accounts | Array of integers Example: accounts=12&accounts=957&accounts=62 Идентификаторы аккаунтов |
| direction | Array of strings Items Enum: "in" "out" Example: direction=in&direction=out Направления переводов |
| limit | integer Example: limit=50 Максимальное количество возвращаемых результатов |
| offset | integer Example: offset=150 Смещение списка возвращаемых результатов |
{- "status": "success",
- "data": [
- {
- "id": 1,
- "amount": 1200.5,
- "currency": "RUB",
- "wallet": 1,
- "status": "pending",
- "created_at": "2022-03-01T15:00:00+03:00",
- "updated_at": "2022-03-01T15:00:00+03:00",
- "network": "yd",
- "account": 1,
- "direction": "in"
}
], - "pagination": {
- "offset": 0,
- "limit": 50,
- "total": 10
}
}| access_token required | string Токен доступа для работы с getUNIQ API |
| account | integer Идентификатор аккаунта |
| wallet | integer Идентификатор кошелька |
| amount | integer Сумма перевода |
{- "account": 1,
- "wallet": 1,
- "amount": 1200
}{- "status": "success",
- "data": {
- "id": 1,
- "amount": 1200.5,
- "currency": "RUB",
- "wallet": 1,
- "status": "pending",
- "created_at": "2022-03-01T15:00:00+03:00",
- "updated_at": "2022-03-01T15:00:00+03:00",
- "network": "yd",
- "account": 1,
- "direction": "in"
}
}| id required | integer Example: 1 |
| access_token required | string Токен доступа для работы с getUNIQ API |
{- "status": "string",
- "data": {
- "id": 1,
- "amount": 1200.5,
- "currency": "RUB",
- "wallet": 1,
- "status": "pending",
- "created_at": "2022-03-01T15:00:00+03:00",
- "updated_at": "2022-03-01T15:00:00+03:00",
- "network": "yd",
- "account": 1,
- "direction": "in"
}
}| network_type required | string Enum: "vk" "yd" Тип рекламной сети |
| access_token required | string Токен доступа для работы с getUNIQ API |
{- "status": "success",
- "data": [
- {
- "id": 1,
- "title": "Иван Иванов"
}
]
}| network_account_id required | string Идентификатор аккаунта в сети |
| access_token required | string Токен доступа для работы с getUNIQ API |
| ids[] | Array of integers |
| statuses[] | Array of strings Items Enum: "active" "paused" "archived" |
| date_from required | string Example: date_from=2021-05-01 Дата начала периода в формате YYYY-MM-DD |
| date_to required | string Example: date_to=2021-05-14 Дата окончания периода в формате YYYY-MM-DD |
| limit | integer Example: limit=50 Максимальное количество возвращаемых результатов |
| offset | integer Example: offset=150 Смещение списка возвращаемых результатов |
{- "status": "success",
- "data": {
- "items": [
- {
- "campaign": {
- "id": 21,
- "external_id": 21,
- "name": "campaign 21",
- "status": "paused"
}, - "cost": 8365.83,
- "cost_with_vat": 10039,
- "clicks": 12021,
- "impressions": 113627,
- "ctr": 10.58,
- "avg_click_price": 0.7,
- "avg_click_price_with_vat": 0.84
}
], - "summary": {
- "cost": 8365.83,
- "cost_with_vat": 10039,
- "clicks": 12021,
- "impressions": 113627,
- "ctr": 10.58,
- "avg_click_price": 0.7,
- "avg_click_price_with_vat": 0.84
}, - "pagination": {
- "offset": 0,
- "limit": 1,
- "total": 10
}
}
}| network_account_id required | string Идентификатор аккаунта в сети |
| access_token required | string Токен доступа для работы с getUNIQ API |
| ids[] | Array of integers |
| statuses[] | Array of strings Items Enum: "active" "paused" "archived" |
| date_from required | string Example: date_from=2021-05-01 Дата начала периода в формате YYYY-MM-DD |
| date_to required | string Example: date_to=2021-05-14 Дата окончания периода в формате YYYY-MM-DD |
| limit | integer Example: limit=50 Максимальное количество возвращаемых результатов |
| offset | integer Example: offset=150 Смещение списка возвращаемых результатов |
{- "status": "success",
- "data": {
- "items": [
- {
- "date": "2023-02-22",
- "cost": 4510,
- "cost_with_vat": 5412,
- "clicks": 6135,
- "impressions": 56202,
- "ctr": 10.92,
- "avg_click_price": 0.74,
- "avg_click_price_with_vat": 0.88
}
], - "summary": {
- "cost": 4510,
- "cost_with_vat": 5412,
- "clicks": 6135,
- "impressions": 56202,
- "ctr": 10.92,
- "avg_click_price": 0.74,
- "avg_click_price_with_vat": 0.88
}, - "pagination": {
- "offset": 0,
- "limit": 1,
- "total": 21
}
}
}| network_account_id required | string Идентификатор аккаунта в сети |
| access_token required | string Токен доступа для работы с getUNIQ API |
| ids[] | Array of integers |
| states[] | Array of strings Items Enum: "archived" "ended" "off" "on" "suspended" "unknown" |
| statuses[] | Array of strings Items Enum: "draft" "moderation" "accepted" "rejected" "unknown" |
| date_from required | string Example: date_from=2021-05-01 Дата начала периода в формате YYYY-MM-DD |
| date_to required | string Example: date_to=2021-05-14 Дата окончания периода в формате YYYY-MM-DD |
| limit | integer Example: limit=50 Максимальное количество возвращаемых результатов |
| offset | integer Example: offset=150 Смещение списка возвращаемых результатов |
{- "status": "success",
- "data": {
- "items": [
- {
- "campaign": {
- "id": 440196,
- "name": "Test API Sandbox campaign 1",
- "status": "accepted",
- "state": "on"
}, - "impressions": 485000,
- "clicks": 38780,
- "cost": 22947.46,
- "cost_with_vat": 27536.952,
- "ctr": 7.9958762886598,
- "avg_click_price": 0.5917343991748324,
- "avg_click_price_with_vat": 0.7100812790097989,
- "profit": 0,
- "revenue": 0,
- "conversions": null,
- "conversion_rate": null
}
], - "summary": {
- "impressions": 485000,
- "clicks": 38780,
- "cost": 22947.46,
- "cost_with_vat": 27536.952,
- "ctr": 7.9958762886598,
- "avg_click_price": 0.5917343991748324,
- "avg_click_price_with_vat": 0.7100812790097989,
- "profit": 0,
- "revenue": 0,
- "conversions": null,
- "conversion_rate": null
}, - "pagination": {
- "offset": 60,
- "limit": 30,
- "total": 100
}
}
}| network_account_id required | string Идентификатор аккаунта в сети |
| access_token required | string Токен доступа для работы с getUNIQ API |
| ids[] | Array of integers |
| states[] | Array of strings Items Enum: "archived" "ended" "off" "on" "suspended" "unknown" |
| statuses[] | Array of strings Items Enum: "draft" "moderation" "accepted" "rejected" "unknown" |
| date_from required | string Example: date_from=2021-05-01 Дата начала периода в формате YYYY-MM-DD |
| date_to required | string Example: date_to=2021-05-14 Дата окончания периода в формате YYYY-MM-DD |
| limit | integer Example: limit=50 Максимальное количество возвращаемых результатов |
| offset | integer Example: offset=150 Смещение списка возвращаемых результатов |
{- "status": "success",
- "data": {
- "items": [
- {
- "date": "2023-03-06",
- "impressions": 95780,
- "clicks": 6615,
- "cost": 3696.61,
- "cost_with_vat": 4435.932,
- "ctr": 6.9064522864899,
- "avg_click_price": 0.5588223733938019,
- "avg_click_price_with_vat": 0.6705868480725624,
- "profit": 0,
- "revenue": 0,
- "conversions": null,
- "conversion_rate": null
}
], - "summary": {
- "impressions": 95780,
- "clicks": 6615,
- "cost": 3696.61,
- "cost_with_vat": 4435.932,
- "ctr": 6.9064522864899,
- "avg_click_price": 0.5588223733938019,
- "avg_click_price_with_vat": 0.6705868480725624,
- "profit": 0,
- "revenue": 0,
- "conversions": null,
- "conversion_rate": null
}, - "pagination": {
- "offset": 0,
- "limit": 1,
- "total": 21
}
}
}| network_account_id required | string Идентификатор аккаунта в сети |
| access_token required | string Токен доступа для работы с getUNIQ API |
| ids[] | Array of integers |
| statuses[] | Array of strings Items Enum: "active" "deleted" "blocked" |
| date_from required | string Example: date_from=2021-05-01 Дата начала периода в формате YYYY-MM-DD |
| date_to required | string Example: date_to=2021-05-14 Дата окончания периода в формате YYYY-MM-DD |
| limit | integer Example: limit=50 Максимальное количество возвращаемых результатов |
| offset | integer Example: offset=150 Смещение списка возвращаемых результатов |
{- "status": "success",
- "data": {
- "items": [
- {
- "campaign": {
- "id": 440196,
- "name": "Test API Sandbox campaign 1",
- "status": "active"
}, - "impressions": 97,
- "clicks": 98,
- "goals": 193,
- "spent": 181.21,
- "spent_with_vat": 97.24,
- "cpm": 12.92,
- "cpm_with_vat": 5.25,
- "cpc": 15.64,
- "cpc_with_vat": 11.42,
- "cpa": 11.89,
- "cpa_with_vat": 22.47,
- "ctr": 9.98,
- "cr": 7.5
}
], - "summary": {
- "impressions": 1361,
- "clicks": 1730,
- "goals": 1395,
- "spent": 1396.5,
- "spent_with_vat": 1479.03,
- "cpm": 150.78,
- "cpm_with_vat": 150.27,
- "cpc": 147.56,
- "cpc_with_vat": 149.51,
- "cpa": 167.02,
- "cpa_with_vat": 164.22,
- "ctr": 147.15,
- "cr": 113.7
}, - "pagination": {
- "offset": 60,
- "limit": 30,
- "total": 100
}
}
}| network_account_id required | string Идентификатор аккаунта в сети |
| access_token required | string Токен доступа для работы с getUNIQ API |
| ids[] | Array of integers |
| statuses[] | Array of strings Items Enum: "active" "deleted" "blocked" |
| date_from required | string Example: date_from=2021-05-01 Дата начала периода в формате YYYY-MM-DD |
| date_to required | string Example: date_to=2021-05-14 Дата окончания периода в формате YYYY-MM-DD |
| limit | integer Example: limit=50 Максимальное количество возвращаемых результатов |
| offset | integer Example: offset=150 Смещение списка возвращаемых результатов |
{- "status": "success",
- "data": {
- "items": [
- {
- "date": "2024-06-10",
- "impressions": 418,
- "clicks": 397,
- "goals": 503,
- "spent": 459.26,
- "spent_with_vat": 560.38,
- "cpm": 40.28,
- "cpm_with_vat": 52.19,
- "cpc": 48.36,
- "cpc_with_vat": 34.89,
- "cpa": 51.36,
- "cpa_with_vat": 44.96,
- "ctr": 42.27,
- "cr": 34.58
}
], - "summary": {
- "impressions": 1361,
- "clicks": 1730,
- "goals": 1395,
- "spent": 1396.5,
- "spent_with_vat": 1479.03,
- "cpm": 150.78,
- "cpm_with_vat": 150.27,
- "cpc": 147.56,
- "cpc_with_vat": 149.51,
- "cpa": 167.02,
- "cpa_with_vat": 164.22,
- "ctr": 147.15,
- "cr": 113.7
}
}
}