API

Obtener análisis de comentarios

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

Devuelve mosaicos resumidos y un gráfico de reseñas para el período especificado. Cada punto representa una hora en UTC; solo se devuelven los puntos no vacíos. La interfaz convierte la hora al huso horario del usuario y agrupa las horas por días. El período predeterminado es hoy. El período está limitado a un año; si el período es más largo, se recorta desde las fechas más recientes. El mosaico de proporción contiene dynamics, que muestra el cambio relativo a date_comparison_*. Si este período no está especificado, por defecto se toma un período de la misma duración inmediatamente anterior al seleccionado. Este valor predeterminado solo se aplica a la comparación y no se devuelve en los filtros.

Autorización

api-token + language + role

Parámetros de consulta

date_fromstring

Ejemplo: 25/04/2024

date_tostring

Ejemplo: 26/04/2024

date_comparison_fromstring

Ejemplo: 25/03/2024

date_comparison_tostring

Ejemplo: 26/03/2024

chain_idinteger

Ejemplo: 1

branch_idinteger

Ejemplo: 1

Respuestas

OK

object
statusstringobligatorio

Valores:successerror

Ejemplo: success

dataobject
filtersobject
date_fromobject (FilterDateFrom)
valuestringpuede ser nulo

Ejemplo: 2026-08-01 00:00:00

typestringobligatorio

Ejemplo: date

modestring (FilterMode)

Cómo la interfaz maneja el filtro; el filtro estándar no tiene mode.
force_shown: siempre visible, no se puede ocultar.
value_required: punto de entrada a la sección; siempre visible, no puede estar vacío (mientras no se seleccione un valor, la lista está vacía; no hay opción "todos"), el reinicio general no lo limpia.

Valores:force_shownvalue_required

Ejemplo: value_required

date_toobject (FilterDateTo)
valuestringpuede ser nulo

Ejemplo: 2026-08-31 23:59:59

typestringobligatorio

Ejemplo: date

modestring (FilterMode)

Cómo la interfaz maneja el filtro; el filtro estándar no tiene mode.
force_shown: siempre visible, no se puede ocultar.
value_required: punto de entrada a la sección; siempre visible, no puede estar vacío (mientras no se seleccione un valor, la lista está vacía; no hay opción "todos"), el reinicio general no lo limpia.

Valores:force_shownvalue_required

Ejemplo: value_required

date_rangeobject (FilterDateRange)

Períodos predefinidos para el filtro de fecha; el límite inferior se calcula según la zona horaria del usuario. value — período correspondiente a los valores actuales de *_from y *_to; null — período personalizado. default — período que el servidor utiliza en la solicitud si no se especifican fechas: también se aplica al cargar la sección por primera vez y al restablecer el filtro. El límite superior del período siempre corresponde al día actual del usuario, por lo que option no lo incluye: no es necesario enviar *_to para un período predefinido, el servidor lo establece automáticamente. Si el período es mayor a un año, se recorta por el límite más reciente.

valuestring (DateRange) puede ser nulo

Período de filtro de fecha predefinido. No tiene su propio parámetro de consulta: el límite inferior ya viene calculado en option y se utiliza en *_from. El límite superior no se envía ni en la respuesta ni en la solicitud: siempre corresponde al día actual del usuario y lo define el servidor.

Valores:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Ejemplo: today

defaultstring (DateRange) obligatorio

Período de filtro de fecha predefinido. No tiene su propio parámetro de consulta: el límite inferior ya viene calculado en option y se utiliza en *_from. El límite superior no se envía ni en la respuesta ni en la solicitud: siempre corresponde al día actual del usuario y lo define el servidor.

Valores:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Ejemplo: today

typestringobligatorio

Ejemplo: select

modestring (FilterMode)

Cómo la interfaz maneja el filtro; el filtro estándar no tiene mode.
force_shown: siempre visible, no se puede ocultar.
value_required: punto de entrada a la sección; siempre visible, no puede estar vacío (mientras no se seleccione un valor, la lista está vacía; no hay opción "todos"), el reinicio general no lo limpia.

Valores:force_shownvalue_required

Ejemplo: value_required

optionarray of objectobligatorio
valuestring (DateRange) obligatorio

Período de filtro de fecha predefinido. No tiene su propio parámetro de consulta: el límite inferior ya viene calculado en option y se utiliza en *_from. El límite superior no se envía ni en la respuesta ni en la solicitud: siempre corresponde al día actual del usuario y lo define el servidor.

Valores:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Ejemplo: today

date_fromstringobligatorio

Ejemplo: 25/08/2026

date_comparison_fromobject (FilterDateFrom)
valuestringpuede ser nulo

Ejemplo: 2026-08-01 00:00:00

typestringobligatorio

Ejemplo: date

modestring (FilterMode)

Cómo la interfaz maneja el filtro; el filtro estándar no tiene mode.
force_shown: siempre visible, no se puede ocultar.
value_required: punto de entrada a la sección; siempre visible, no puede estar vacío (mientras no se seleccione un valor, la lista está vacía; no hay opción "todos"), el reinicio general no lo limpia.

Valores:force_shownvalue_required

Ejemplo: value_required

date_comparison_toobject (FilterDateTo)
valuestringpuede ser nulo

Ejemplo: 2026-08-31 23:59:59

typestringobligatorio

Ejemplo: date

modestring (FilterMode)

Cómo la interfaz maneja el filtro; el filtro estándar no tiene mode.
force_shown: siempre visible, no se puede ocultar.
value_required: punto de entrada a la sección; siempre visible, no puede estar vacío (mientras no se seleccione un valor, la lista está vacía; no hay opción "todos"), el reinicio general no lo limpia.

Valores:force_shownvalue_required

Ejemplo: value_required

date_comparison_rangeobject (FilterDateRangeOptional)

Períodos predefinidos para el filtro de fechas sin valor por defecto: default siempre es null.

valuestring (DateRange) puede ser nulo

Período de filtro de fecha predefinido. No tiene su propio parámetro de consulta: el límite inferior ya viene calculado en option y se utiliza en *_from. El límite superior no se envía ni en la respuesta ni en la solicitud: siempre corresponde al día actual del usuario y lo define el servidor.

Valores:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Ejemplo: today

defaultstring (DateRange) puede ser nulo

Período de filtro de fecha predefinido. No tiene su propio parámetro de consulta: el límite inferior ya viene calculado en option y se utiliza en *_from. El límite superior no se envía ni en la respuesta ni en la solicitud: siempre corresponde al día actual del usuario y lo define el servidor.

Valores:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Ejemplo: today

typestringobligatorio

Ejemplo: select

optionarray of objectobligatorio
valuestring (DateRange) obligatorio

Período de filtro de fecha predefinido. No tiene su propio parámetro de consulta: el límite inferior ya viene calculado en option y se utiliza en *_from. El límite superior no se envía ni en la respuesta ni en la solicitud: siempre corresponde al día actual del usuario y lo define el servidor.

Valores:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Ejemplo: today

date_fromstringobligatorio

Ejemplo: 25/08/2026

chain_idobject (FilterSelectInteger)
valueinteger

Ejemplo: 8920

typestringobligatorio

Ejemplo: select

optionarray of object
valueintegerobligatorio

Ejemplo: 8920

namestringobligatorio

Ejemplo: Green Basket | Kaliningrad

modestring (FilterMode)

Cómo la interfaz maneja el filtro; el filtro estándar no tiene mode.
force_shown: siempre visible, no se puede ocultar.
value_required: punto de entrada a la sección; siempre visible, no puede estar vacío (mientras no se seleccione un valor, la lista está vacía; no hay opción "todos"), el reinicio general no lo limpia.

Valores:force_shownvalue_required

Ejemplo: value_required

branch_idobject (FilterSelectInteger)
valueinteger

Ejemplo: 8920

typestringobligatorio

Ejemplo: select

optionarray of object
valueintegerobligatorio

Ejemplo: 8920

namestringobligatorio

Ejemplo: Green Basket | Kaliningrad

modestring (FilterMode)

Cómo la interfaz maneja el filtro; el filtro estándar no tiene mode.
force_shown: siempre visible, no se puede ocultar.
value_required: punto de entrada a la sección; siempre visible, no puede estar vacío (mientras no se seleccione un valor, la lista está vacía; no hay opción "todos"), el reinicio general no lo limpia.

Valores:force_shownvalue_required

Ejemplo: value_required

tilesobject
totalobject (FeedbackAnalyticsCountTile) obligatorio

Contador en la fila de resumen: cantidad de reseñas y su porcentaje durante el período. percent es null si no hay ninguna reseña en el período. El cambio respecto al período de comparación no se transmite intencionadamente: la cantidad de reseñas depende del tráfico, por lo que su aumento no indica la calidad.

valueintegerobligatorio

Ejemplo: 96

percentnumber · float

Ejemplo: 75

positiveobject (FeedbackAnalyticsCountTile) obligatorio

Contador en la fila de resumen: cantidad de reseñas y su porcentaje durante el período. percent es null si no hay ninguna reseña en el período. El cambio respecto al período de comparación no se transmite intencionadamente: la cantidad de reseñas depende del tráfico, por lo que su aumento no indica la calidad.

valueintegerobligatorio

Ejemplo: 96

percentnumber · float

Ejemplo: 75

negativeobject (FeedbackAnalyticsCountTile) obligatorio

Contador en la fila de resumen: cantidad de reseñas y su porcentaje durante el período. percent es null si no hay ninguna reseña en el período. El cambio respecto al período de comparación no se transmite intencionadamente: la cantidad de reseñas depende del tráfico, por lo que su aumento no indica la calidad.

valueintegerobligatorio

Ejemplo: 96

percentnumber · float

Ejemplo: 75

positive_shareobject (FeedbackAnalyticsShareTile) obligatorio

Ficha de cuota en la fila de resumen. A diferencia de los contadores, contiene dynamics, que es el cambio de la cuota respecto al período de comparación en puntos porcentuales; no depende del tráfico. percent y dynamics son null si no hay base para el cálculo: no hay reseñas en el período o en el período de comparación.

valueintegerobligatorio

Ejemplo: 96

percentnumber · float

Ejemplo: 75

dynamicsnumber · float

Ejemplo: -0.2

pointsarray of object
datetimestringobligatorio

Inicio del intervalo horario en UTC

Ejemplo: 2026-09-08 10:00:00

positiveintegerobligatorio

Ejemplo: 3

negativeintegerobligatorio

Ejemplo: 1