API

Отримати аналітику акцій

GET/api/crm/v2/special_offers_analyticsv2
operationId: specialOffersAnalytics.default

Авторизація

api-token + language + role

Параметри запиту

date_creation_fromstring

Приклад: 25/04/2024

date_creation_tostring

Приклад: 26/04/2024

chain_idinteger
branch_idinteger
promo_codestring

Приклад: SALE20

typestring

Приклад: percent_discount_on_all_order

special_offer_idinteger

Приклад: 152410

platformstring (OrderPlatform)

Платформа замовлення

Значення:androidapifbiosvksite

order_statusstring (OrderStatus)

Статус замовлення: в дорозі, виконано, збірка, на кухні, не оброблено, готовий до відправки, очікує відправки на кухню, очікує переробки, скасовано, підтверджено, приготовано

Значення:in_transitdoneassemblyin_kitchennot_processedready_to_transitwait_to_kitchenwait_remadecanceledconfirmedcooked

Приклад: confirmed

payment_statusstring (OrderPayment)

Статус оплати: не оплачено, очікує, оплачено

Значення:not_paidwaitingpaid

delivery_methodstring (OrderDelivery)

Спосіб доставки: кур'єр або самовивіз

Значення:courierpickup

Відповіді

OK

object
statusstringобов’язковий

Значення:successerror

Приклад: success

dataobject
filtersobject
date_creation_fromobject (FilterDateFrom)
valuestringможе бути null

Приклад: 2026-08-01 00:00:00

typestringобов’язковий

Приклад: date

modestring (FilterMode)

Як інтерфейс обробляє фільтр; у звичайного фільтра mode немає. force_shown — завжди відображається, приховати не можна. value_required — точка входу в розділ: завжди відображається, не має порожнього значення (поки значення не вибрано, список порожній; варіанту «всі» немає), загальне скидання його не очищає.

Значення:force_shownvalue_required

Приклад: value_required

date_creation_toobject (FilterDateTo)
valuestringможе бути null

Приклад: 2026-08-31 23:59:59

typestringобов’язковий

Приклад: date

modestring (FilterMode)

Як інтерфейс обробляє фільтр; у звичайного фільтра mode немає. force_shown — завжди відображається, приховати не можна. value_required — точка входу в розділ: завжди відображається, не має порожнього значення (поки значення не вибрано, список порожній; варіанту «всі» немає), загальне скидання його не очищає.

Значення:force_shownvalue_required

Приклад: value_required

date_creation_rangeobject (FilterDateRange)

Готові періоди фільтра за датою; нижня межа розраховується у часовому поясі користувача. value — період, якому відповідають поточні *_from та *_to; null — довільний період. default — період, який сервер підставляє у запит без дат: також застосовується при першому завантаженні розділу та при скиданні. Верхня межа періоду завжди дорівнює поточному дню користувача, тому option її не містить: передавати *_to для готового періоду не потрібно, сервер встановлює її самостійно. Період довший за рік обрізається зі сторони новішої межі.

valuestring (DateRange) може бути null

Готовий період фільтра за датою. Власного параметра запиту не має: нижня межа вже розрахована в option і підставляється в *_from. Верхня межа не передається ні у відповіді, ні у запиті — вона завжди дорівнює поточному дню користувача і задається сервером.

Значення:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Приклад: today

defaultstring (DateRange) обов’язковий

Готовий період фільтра за датою. Власного параметра запиту не має: нижня межа вже розрахована в option і підставляється в *_from. Верхня межа не передається ні у відповіді, ні у запиті — вона завжди дорівнює поточному дню користувача і задається сервером.

Значення:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Приклад: today

typestringобов’язковий

Приклад: select

modestring (FilterMode)

Як інтерфейс обробляє фільтр; у звичайного фільтра mode немає. force_shown — завжди відображається, приховати не можна. value_required — точка входу в розділ: завжди відображається, не має порожнього значення (поки значення не вибрано, список порожній; варіанту «всі» немає), загальне скидання його не очищає.

Значення:force_shownvalue_required

Приклад: value_required

optionarray of objectобов’язковий
valuestring (DateRange) обов’язковий

Готовий період фільтра за датою. Власного параметра запиту не має: нижня межа вже розрахована в option і підставляється в *_from. Верхня межа не передається ні у відповіді, ні у запиті — вона завжди дорівнює поточному дню користувача і задається сервером.

Значення:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Приклад: today

date_fromstringобов’язковий

Приклад: 25/08/2026

chain_idobject (FilterSelectInteger)
valueinteger

Приклад: 8920

typestringобов’язковий

Приклад: select

optionarray of object
valueintegerобов’язковий

Приклад: 8920

namestringобов’язковий

Приклад: Green Basket | Kaliningrad

modestring (FilterMode)

Як інтерфейс обробляє фільтр; у звичайного фільтра mode немає. force_shown — завжди відображається, приховати не можна. value_required — точка входу в розділ: завжди відображається, не має порожнього значення (поки значення не вибрано, список порожній; варіанту «всі» немає), загальне скидання його не очищає.

Значення:force_shownvalue_required

Приклад: value_required

branch_idobject (FilterSelectInteger)
valueinteger

Приклад: 8920

typestringобов’язковий

Приклад: select

optionarray of object
valueintegerобов’язковий

Приклад: 8920

namestringобов’язковий

Приклад: Green Basket | Kaliningrad

modestring (FilterMode)

Як інтерфейс обробляє фільтр; у звичайного фільтра mode немає. force_shown — завжди відображається, приховати не можна. value_required — точка входу в розділ: завжди відображається, не має порожнього значення (поки значення не вибрано, список порожній; варіанту «всі» немає), загальне скидання його не очищає.

Значення:force_shownvalue_required

Приклад: value_required

promo_codeobject (FilterInput)
valuestring

Приклад: example

typestringобов’язковий

Приклад: integer or string

placeholderstring

Приклад: string

modestring (FilterMode)

Як інтерфейс обробляє фільтр; у звичайного фільтра mode немає. force_shown — завжди відображається, приховати не можна. value_required — точка входу в розділ: завжди відображається, не має порожнього значення (поки значення не вибрано, список порожній; варіанту «всі» немає), загальне скидання його не очищає.

Значення:force_shownvalue_required

Приклад: value_required

typeobject (FilterEnum)

Фільтр-перерахування — плоский список значень перерахування

valuestring

Приклад: example

typestringобов’язковий

Приклад: select

optionarray of string
modestring (FilterMode)

Як інтерфейс обробляє фільтр; у звичайного фільтра mode немає. force_shown — завжди відображається, приховати не можна. value_required — точка входу в розділ: завжди відображається, не має порожнього значення (поки значення не вибрано, список порожній; варіанту «всі» немає), загальне скидання його не очищає.

Значення:force_shownvalue_required

Приклад: value_required

special_offer_idobject (FilterSelectInteger)
valueinteger

Приклад: 8920

typestringобов’язковий

Приклад: select

optionarray of object
valueintegerобов’язковий

Приклад: 8920

namestringобов’язковий

Приклад: Green Basket | Kaliningrad

modestring (FilterMode)

Як інтерфейс обробляє фільтр; у звичайного фільтра mode немає. force_shown — завжди відображається, приховати не можна. value_required — точка входу в розділ: завжди відображається, не має порожнього значення (поки значення не вибрано, список порожній; варіанту «всі» немає), загальне скидання його не очищає.

Значення:force_shownvalue_required

Приклад: value_required

platformobject (FilterEnum)

Фільтр-перерахування — плоский список значень перерахування

valuestring

Приклад: example

typestringобов’язковий

Приклад: select

optionarray of string
modestring (FilterMode)

Як інтерфейс обробляє фільтр; у звичайного фільтра mode немає. force_shown — завжди відображається, приховати не можна. value_required — точка входу в розділ: завжди відображається, не має порожнього значення (поки значення не вибрано, список порожній; варіанту «всі» немає), загальне скидання його не очищає.

Значення:force_shownvalue_required

Приклад: value_required

order_statusobject (FilterEnum)

Фільтр-перерахування — плоский список значень перерахування

valuestring

Приклад: example

typestringобов’язковий

Приклад: select

optionarray of string
modestring (FilterMode)

Як інтерфейс обробляє фільтр; у звичайного фільтра mode немає. force_shown — завжди відображається, приховати не можна. value_required — точка входу в розділ: завжди відображається, не має порожнього значення (поки значення не вибрано, список порожній; варіанту «всі» немає), загальне скидання його не очищає.

Значення:force_shownvalue_required

Приклад: value_required

payment_statusobject (FilterEnum)

Фільтр-перерахування — плоский список значень перерахування

valuestring

Приклад: example

typestringобов’язковий

Приклад: select

optionarray of string
modestring (FilterMode)

Як інтерфейс обробляє фільтр; у звичайного фільтра mode немає. force_shown — завжди відображається, приховати не можна. value_required — точка входу в розділ: завжди відображається, не має порожнього значення (поки значення не вибрано, список порожній; варіанту «всі» немає), загальне скидання його не очищає.

Значення:force_shownvalue_required

Приклад: value_required

delivery_methodobject (FilterEnum)

Фільтр-перерахування — плоский список значень перерахування

valuestring

Приклад: example

typestringобов’язковий

Приклад: select

optionarray of string
modestring (FilterMode)

Як інтерфейс обробляє фільтр; у звичайного фільтра mode немає. force_shown — завжди відображається, приховати не можна. value_required — точка входу в розділ: завжди відображається, не має порожнього значення (поки значення не вибрано, список порожній; варіанту «всі» немає), загальне скидання його не очищає.

Значення:force_shownvalue_required

Приклад: value_required

totalobject (SpecialOffersAnalyticsValues)
countintegerобов’язковий

Приклад: 412

sumnumberобов’язковий

Приклад: 531420.5

averagenumberобов’язковий

Приклад: 1289.86

completed_countintegerобов’язковий

Замовлення, що досягли статусу done або confirmed

Приклад: 379

completed_sharenumberобов’язковий

Частка завершених замовлень у цій половині, у відсотках

Приклад: 91.99

share_of_countnumberобов’язковий

Частка від усіх замовлень за період, у відсотках

Приклад: 34.2

share_of_sumnumberобов’язковий

Приклад: 29.7

segmentsarray of object
keystringобов’язковий

Що означає половина. Якщо вибрано промокод, тип акції або конкретну акцію, перша половина звужується, і пара стає matched_filter та rest; знаменник у будь-якому випадку — всі замовлення періоду. Визначайте половину за key, а не за позицією.

Значення:with_promo_codewithout_promo_codematched_filterrest

Приклад: with_promo_code

valuesobject (SpecialOffersAnalyticsValues) обов’язковий
countintegerобов’язковий

Приклад: 412

sumnumberобов’язковий

Приклад: 531420.5

averagenumberобов’язковий

Приклад: 1289.86

completed_countintegerобов’язковий

Замовлення, що досягли статусу done або confirmed

Приклад: 379

completed_sharenumberобов’язковий

Частка завершених замовлень у цій половині, у відсотках

Приклад: 91.99

share_of_countnumberобов’язковий

Частка від усіх замовлень за період, у відсотках

Приклад: 34.2

share_of_sumnumberобов’язковий

Приклад: 29.7

differenceobject

Перша половина мінус друга, в абсолютних значеннях; частки віднімаються у відсоткових пунктах

countinteger

Приклад: -284

sumnumber

Приклад: -412300.1

averagenumber

Приклад: 180.4

completed_sharenumber

Приклад: -3.11