API

Отримати аналітику відгуків

GET/api/crm/v2/feedback_analyticsv2
operationId: feedbackAnalytics.default

Повертає зведені плитки та графік відгуків за період. Кожна точка — одна година в UTC; повертаються лише непорожні точки. Інтерфейс самостійно переводить час у часовий пояс користувача та групує години у дні. Період за замовчуванням — сьогодні. Період обмежений одним роком; довший період обрізається з боку останніх дат. Плитка частки містить dynamics — зміну відносно date_comparison_*. Якщо цей період не задано, за замовчуванням береться період такої ж тривалості безпосередньо перед вибраним. Це значення за замовчуванням застосовується лише до порівняння і не повертається у фільтрах.

Авторизація

api-token + language + role

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

date_fromstring

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

date_tostring

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

date_comparison_fromstring

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

date_comparison_tostring

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

chain_idinteger

Приклад: 1

branch_idinteger

Приклад: 1

Відповіді

OK

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

Значення:successerror

Приклад: success

dataobject
filtersobject
date_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_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_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

date_comparison_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_comparison_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_comparison_rangeobject (FilterDateRangeOptional)

Готові періоди фільтра дат без значення за замовчуванням: default завжди дорівнює null.

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

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

Значення:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Приклад: today

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

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

Значення:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Приклад: today

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

Приклад: select

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

tilesobject
totalobject (FeedbackAnalyticsCountTile) обов’язковий

Лічильник у зведеному рядку: кількість відгуків та їхня частка за період. percent дорівнює null, якщо за період немає жодного відгуку. Зміна відносно періоду порівняння навмисно не передається: кількість відгуків залежить від трафіку, тому її зростання нічого не говорить про якість.

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

Приклад: 96

percentnumber · float

Приклад: 75

positiveobject (FeedbackAnalyticsCountTile) обов’язковий

Лічильник у зведеному рядку: кількість відгуків та їхня частка за період. percent дорівнює null, якщо за період немає жодного відгуку. Зміна відносно періоду порівняння навмисно не передається: кількість відгуків залежить від трафіку, тому її зростання нічого не говорить про якість.

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

Приклад: 96

percentnumber · float

Приклад: 75

negativeobject (FeedbackAnalyticsCountTile) обов’язковий

Лічильник у зведеному рядку: кількість відгуків та їхня частка за період. percent дорівнює null, якщо за період немає жодного відгуку. Зміна відносно періоду порівняння навмисно не передається: кількість відгуків залежить від трафіку, тому її зростання нічого не говорить про якість.

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

Приклад: 96

percentnumber · float

Приклад: 75

positive_shareobject (FeedbackAnalyticsShareTile) обов’язковий

Плитка частки у зведеному рядку. На відміну від лічильників, містить dynamics — зміну частки відносно періоду порівняння у відсоткових пунктах; вона не залежить від трафіку. percent та dynamics дорівнюють null, якщо немає з чого рахувати: відсутні відгуки за період або за період порівняння.

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

Приклад: 96

percentnumber · float

Приклад: 75

dynamicsnumber · float

Приклад: -0.2

pointsarray of object
datetimestringобов’язковий

Початок годинної точки в UTC

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

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

Приклад: 3

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

Приклад: 1