Параметр | Тип | Обязательность | Описание |
---|---|---|---|
page | число | нет | Номер страницы |
limit | число | нет | Количество записей на странице |
sort | строка | нет | Используется при get запросе. Сортировка по столбцу. Допустимые значения: id, -id, amount, -amount, amount_per_show, -amount_per_show, date_end_fact, -date_end_fact, date_end_plan, -date_end_plan, date_start_fact, -date_start_fact, date_start_plan, -date_start_plan, imps_fact, -imps_fact, imps_plan, -imps_plan |
Код ответа | Описание |
---|---|
200 OK | Положительный статус запроса |
401 Unauthorized | Доступ запрещен, невалидный токен |
Параметр | Тип | Обязательность | Описание |
---|---|---|---|
id | число | да | идентификатор статистики |
Код ответа | Описание |
---|---|
200 OK | Статус успешного запроса |
401 Unauthorized | Доступ запрещен, невалидный токен |
404 Not found | Идентификатор статистики не найден |
Код ответа | Описание |
---|---|
201 Created | Статистика создана |
401 Unauthorized | Доступ запрещен, невалидный токен |
422 Unprocessable Content | Некорректный запрос |
Параметр | Тип | Обязательность | Описание |
---|---|---|---|
id | число | да | идентификатор статистики |
Код ответа | Описание |
---|---|
200 OK | Статус успешного запроса |
401 Unauthorized | Доступ запрещен, невалидный токен |
404 Not found | Идентификатор статистики не найден |
422 Unprocessable Content | Некорректный запрос |
Параметр | Тип | Обязательность | Описание |
---|---|---|---|
id | число | да | идентификатор статистики |
Код ответа | Описание |
---|---|
204 No Content | Статус успешного запроса |
401 Unauthorized | Доступ запрещен, невалидный токен |
404 Not found | Идентификатор статистики не найден |
Параметр | Тип | Обязательность | Описание |
---|---|---|---|
id | число | да | идентификатор статистики |
Код ответа | Описание |
---|---|
200 OK | Статус успешного запроса |
401 Unauthorized | Доступ запрещен, невалидный токен |
404 Not found | Идентификатор статистики не найден |
Код ответа | Описание |
---|---|
200 OK | Статус успешного запроса |
401 Unauthorized | Доступ запрещен, невалидный токен |
422 Unprocessable Content | Некорректный запрос |
Код ответа | Описание |
---|---|
204 No Content | Статус успешного запроса |
401 Unauthorized | Доступ запрещен, невалидный токен |
422 Unprocessable Content | Некорректный запрос |
Параметр | Тип | Обязательность | Описание |
---|---|---|---|
id | число | да | Идентификатор статистики |
contract_id | строка (255) | да | Идентификатор креатива Минимальная длина: 1 |
platform_id | строка (255) | да | Идентификатор площадки Минимальная длина: 1 |
imps_fact | число | да | Количество показов фактическое Целое положительное число или нулевое.Если у креатива, к которому относится статистика, признак isNative равен true, то значение должно равняться 0. |
imps_plan | число | да | Количество показов по акту Целое положительное число или нулевоеEсли у креатива, к которому относится статистика, признак isNative равен true, то значение должно равняться 0 |
date_start _fact | дата в формате ГГГГ-мм-дд | да | Дата начала показов фактическая
|
date_end _fact | дата в формате ГГГГ-мм-дд | да | Дата окончания показов фактическая
|
date_start _plan | дата в формате ГГГГ-мм-дд | да | Дата начала показов по акту
|
date_end _plan | дата в формате ГГГГ-мм-дд | да | Дата окончания показов по акту
|
amount | число с плавающей запятой Если передавать 5 знаков после запятой (0.00001), использовать тип строка |
да | Стоимость оказанных услуг Положительные числа или нулевые |
amount_per _show | число с плавающей запятой Если передавать 5 знаков после запятой (0.00001), использовать тип строка |
да | Стоимость единицы оказания услуг Положительные числа или нулевые Если деньги списываются за показы, то стоимость указывается за 1000 показов. Если деньги списываются за действие, то стоимость указывается за какое-то действие. |
type | Строка (5) | нет, станет обязательным с 01.10.24. | Тип рекламной кампании. Возможные значения: other - Иное; cpm - CPM; cpc - CPC; cpa - CPA. |
is_vat | булево | да | Признак "с НДС" Возможные значения: true / false |
invoice_ item_id | число | нет | Идентификатор детализации акта по атрибутам изначального договора (пункта акта). Если не передавать данное поле, то статистика по креативу сохранится без привязки к акту и изначальному договору. |
external_id | Строка (255) | нет | Учетный идентификатор в базе пользователя |
include | Строка | нет | Параметр получения статусов сущностей для GET запроса, значение – erirEntity пример использования: https://api.ord-a.ru/api/v2/statistics?include=erirEntity В json ответе от сервера появятся данные ( ... "erir_entity": { "id": 10454, "status": "Регистрация", "status_label": "registration", "last_item": { "id": 15148, "status": "Регистрация", "status_label": "registration", "errors": [], "message": null, "created_at": "2024-07-18T11:55:20+03:00", "pending_at": "2024-07-18T12:00:20+03:00", "status_changed_at": "2024-07-18T12:00:23+03:00" }, "registered_at": null, "created_at": "2024-07-18T11:55:19+03:00" } ... |
filter [option] | нет | Параметр получения статусов сущностей для GET запроса Параметр для поиска записей сущностей для GET запроса, допустимые значения: id, platform, creative_id, invoice_item_id, imps_fact, imps_plan, period_fact, period_plan, amount, amount_per_show, status (1, 2, 3, 4, 10), external_id. Пример запроса - https://api.ord-a.ru/api/v2/statistics/?filter[id]=4 Пример запроса для фильтра по периоду https://api.ord-a.ru/api/v2/statistics?filter[period_fact]=20.07.2023-22.07.2023 |
|
sort | нет | Параметр получения статусов сущностей для GET запроса Параметр для сортировки массива сущностей для GET запроса, допустимые значения: id, -id, amount, -amount, amount_per_show, -amount_per_show, date_end_fact, -date_end_fact, date_end_plan, -date_end_plan, date_start_fact, -date_start_fact, date_start_plan, -date_start_plan, imps_fact, -imps_fact, imps_plan, -imps_plan Пример запроса - https://api.ord-a.ru/api/v2/ statistics?sort=amount |
Параметр | Описание |
---|---|
include | Параметр для получения статусов сущностей для GET запроса, значение – erirEntity Пример использования: https://api.ord-a.ru/api/v2/statistics?include=erirEntity В json ответе от сервера появятся данные ( ... "erir_entity": { … "id": 1391519, "errors": [], "message": null, "status": "Регистрация", "status_label": "registration", … }, ... ) |
filter[id] | Параметр для поиска записей сущностей для GET запроса по id, Пример запроса - https://api.ord-a.ru/api/v2/statistics/?filter[id]=454 |
filter[platform] | Параметр для поиска записей сущностей для GET запроса по platform, Пример запроса - https://api.ord-a.ru/api/v2/statistics/?filter[platform]=Тест |
filter[creative_id] | Параметр для поиска записей сущностей для GET запроса по creative_id, Пример запроса - https://api.ord-a.ru/api/v2/statistics/?filter[creative_id]=1083403 |
filter [invoice_item_id] | Параметр для поиска записей сущностей для GET запроса по invoice_item_id, Пример запроса - https://api.ord-a.ru/api/v2/statistics/?filter[invoice_item_id]=68845 |
filter[imps_fact] | Параметр для поиска записей сущностей для GET запроса по imps_fact, Пример запроса - https://api.ord-a.ru/api/v2/statistics/?filter[imps_fact]=4 |
filter[imps_plan] | Параметр для поиска записей сущностей для GET запроса по imps_plan, Пример запроса - https://api.ord-a.ru/api/v2/statistics/?filter[imps_plan]=4 |
filter[period_fact] | Параметр для поиска записей сущностей для GET запроса по period_fact, Пример запроса - https://api.ord-a.ru/api/v2/statistics/?filter[period_fact]=20.07.2023-22.07.2023 |
filter[period_plan] | Параметр для поиска записей сущностей для GET запроса по period_plan, Пример запроса - https://api.ord-a.ru/api/v2/statistics/?filter[period_plan]=20.07.2023-22.07.2023 |
filter[amount] | Параметр для поиска записей сущностей для GET запроса по amount, Пример запроса - https://api.ord-a.ru/api/v2/statistics/?filter[amount]=40 |
filter [amount_per_show] | Параметр для поиска записей сущностей для GET запроса по period_plan, Пример запроса - https://api.ord-a.ru/api/v2/statistics/?filter[amount_per_show]=600 |
filter[external_id] | Учетный идентификатор в базе пользователя |
sort | Параметр для сортировки массива сущностей для GET запроса, допустимые значения:
id, -id, amount, -amount, amount_per_show, -amount_per_show, date_end_fact, -date_end_fact, date_end_plan, -date_end_plan, date_start_fact, -date_start_fact, date_start_plan, -date_start_plan, imps_fact, -imps_fact, imps_plan, -imps_plan. Пример запроса - https://api.ord-a.ru/api/v2/ statistics?sort=amount |
Параметр | Тип | Обязательность | Описание |
---|---|---|---|
id | число | да | идентификатор пункта акта |
Код ответа | Описание |
---|---|
200 ОК | Статус успешного запроса |
401 Unauthorized | Доступ запрещен, невалидный токен |
404 Not found | Идентификатор пункта акта не найден |
Параметр | Тип | Обязательность | Описание |
---|---|---|---|
id | число | да | идентификатор пункта акта |
Код ответа | Описание |
---|---|
200 ОК | Статус успешного запроса |
401 Unauthorized | Доступ запрещен, невалидный токен |
422 Unprocessable Content | Некорректный запрос |
Параметр | Тип | Обязательность | Описание |
---|---|---|---|
id | число | да | идентификатор пункта акта |
Код ответа | Описание |
---|---|
200 ОК | Статус успешного запроса |
401 Unauthorized | Доступ запрещен, невалидный токен |
422 Unprocessable Content | Некорректный запрос |
Параметр | Тип | Обязательность | Описание |
---|---|---|---|
id | число | да | Идентификатор разаллокации актов по креативам (идентификатор пункта акта) |
Код ответа | Описание |
---|---|
200 ОК | Статус успешного запроса |
401 Unauthorized | Доступ запрещен, невалидный токен |
422 Unprocessable Content | Некорректный запрос |
Параметр | Тип | Обязательность | Описание |
---|---|---|---|
invoices_item_id | число | да | Идентификатор разаллокации актов по креативам (идентификатор пункта акта) |
creative_ids | массив | да | Массив id креативов |
Код ответа | Описание |
---|---|
200 ОК | Статус успешного запроса |
401 Unauthorized | Доступ запрещен, невалидный токен |
404 Not found | Идентификатор пункта акта не найден |
422 Unprocessable Content | Некорректный запрос |
Код ответа | Описание |
---|---|
200 ОК | Статус успешного запроса |
401 Unauthorized | Доступ запрещен, невалидный токен |
404 Not found | Контрагент не найден |
Параметр | Тип | Обязательность | Описание |
---|---|---|---|
id | число | да | Идентификатор контрагентов |
ids | массив | да | Массив идентификаторов площадок |
Код ответа | Описание |
---|---|
200 ОК | Запрос выполнен |
401 Unauthorized | Доступ запрещен, невалидный токен |
422 Unprocessable Content | Доступ запрещен |
Параметр | Тип | Обязательность | Описание |
---|---|---|---|
model_type | строка | да | model_type – тип отправляемой сущности. Допустимые значения - organization, platform, contract, creative, invoice, statistic |
model_ids | массив | да | Массив отправляемыx id – значений сущностей |
Тэг | Метод | Роут | Реализовано в V1 | Реализовано в V2 |
---|---|---|---|---|
Auth | POST | /auth | да | да |
Organizations | GET | /organizations | да | да |
Organizations | POST | /organizations | да | да |
Organizations | GET | /organizations /{id} | да | да |
Organizations | PUT | /organizations /{id} | да | да |
Organizations | DELETE | /organizations /{id} | да | да |
Organizations | GET | /organizations /{id} /restore | да | да |
Organizations | POST | /organizations /upsert | да | |
Platforms | GET | /platforms | да | да |
Platforms | POST | /platforms | да | да |
Platforms | GET | /platforms /{id} | да | да |
Platforms | PUT | /platforms /{id} | да | да |
Platforms | DELETE | /platforms /{id} | да | да |
Platforms | GET | /platforms /{id} /restore | да | да |
Platforms | POST | /platforms /upsert | да | |
Contracts | GET | /contracts | да | да |
Contracts | POST | /contracts | да | да |
Contracts | GET | /contracts /{id} | да | да |
Contracts | PUT | /contracts /{id} | да | да |
Contracts | DELETE | /contracts /{id} | да | да |
Contracts | GET | /contracts /{id} /restore | да | да |
Contracts | POST | /contracts /upsert | да | |
Creatives | GET | /creatives | да | да |
Creatives | POST | /creatives | да | да |
Creatives | GET | /creatives /{id} | да | да |
Creatives | PUT | /creatives /{id} | да | да |
Creatives | DELETE | /creatives /{id} | да | да |
Creatives | GET | /creatives /{id} /restore | да | да |
Creatives | POST | /creatives /upsert | да | |
CreativeItems | GET | /creatives /{creative_id} /items | да | |
CreativeItems | POST | /creatives /{creative_id} /items | да | |
CreativeItems | GET | /creatives /{creative_id} /items /{id} | да | |
CreativeItems | PUT | /creatives /{creative_id} /items /{id} | да | |
CreativeItems | DELETE | /creatives /{creative_id} /items /{id} | да | |
CreativeItems | GET | /creatives /{creative_id} /items /{id} /restore | да | |
CreativeItems | GET | /creatives /{creative_id} /items /insert | да | |
Invoices | GET | /invoices | да | да |
Invoices | POST | /invoices | да | да |
Invoices | GET | /invoices /{id} | да | да |
Invoices | PUT | /invoices /{id} | да | да |
Invoices | GET | /invoices /{id} /restore | да | да |
Invoices | POST | /invoices /upsert | да | |
InvoiceCreatives | GET | /invoices /creatives | да | |
InvoiceCreatives | POST | /invoices /creatives | да | |
InvoiceCreatives | GET | /invoices /creatives /{id} | да | |
InvoiceCreatives | PUT | /invoices /creatives /{id} | да | |
InvoiceCreatives | DELETE | /invoices /creatives /{id} | да | |
InvoiceCreatives | GET | /invoices /creatives /{id} /restore | да | |
InvoiceItems | GET | /invoices /items | да | да |
InvoiceItems | POST | /invoices /items | да | да |
InvoiceItems | GET | /invoices /items /{id} | да | да |
InvoiceItems | PUT | /invoices /items /{id} | да | да |
InvoiceItems | DELETE | /invoices /items /{id} | да | да |
InvoiceItems | GET | /invoices /items /{id} /restore | да | да |
InvoiceItems | POST | /invoices /items /upsert | да | |
Media | GET | /media /{model_type} /{model_id} | да | да |
Media | POST | /media /{model_type} /{id} | да | да |
Media | PUT | /media /user /{id} | да | да |
Media | DELETE | /media /{id} | да | да |
Erir | POST | /send-erir /{model_type} | да | да |
OrganizationPlatform | POST | /organizations /{id} /attach | да | да |
OrganizationPlatform | POST | /organizations /{id} /detach | да | да |
Statistics | GET | /statistics | да | |
Statistics | POST | /statistics | да | |
Statistics | GET | /statistics /{id} | да | |
Statistics | PUT | /statistics /{id} | да | |
Statistics | DELETE | /statistics /{id} | да | |
Statistics | GET | /statistics /{id} /restore | да | |
Statistics | POST | /statistics /items /upsert | да | |
InvoiceItemCreative | GET | /invoices /items /{id} /creatives | да | |
InvoiceItemCreative | POST | /invoices /items /{id} /creatives-sync | да | |
InvoiceItemCreative | POST | /invoices /items /{id} /creatives-attach | да | |
InvoiceItemCreative | POST | /invoices /items /{id} /creatives-detach | да | |
InvoiceItemCreative | POST | /invoices /items /{id} /creatives-attach-import | да | |
InvoiceItemCreative | POST | /import /excel /invoice_item_ statistic | да | |
UserMedia | GET | /user /media | да | |
UserMedia | POST | /user /media | да | |
UserMedia | DELETE | /user /media | да |