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