API

Obtener análisis de promociones

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

Autorización

api-token + language + role

Parámetros de consulta

date_creation_fromstring

Ejemplo: 25/04/2024

date_creation_tostring

Ejemplo: 26/04/2024

chain_idinteger
branch_idinteger
promo_codestring

Ejemplo: SALE20

typestring

Ejemplo: percent_discount_on_all_order

special_offer_idinteger

Ejemplo: 152410

platformstring (OrderPlatform)

Plataforma de pedido

Valores:androidapifbiosvksite

order_statusstring (OrderStatus)

Estado del pedido: en camino, completado, en preparación, en cocina, no procesado, listo para enviar, esperando envío a cocina, esperando rehacer, cancelado, confirmado, preparado

Valores:in_transitdoneassemblyin_kitchennot_processedready_to_transitwait_to_kitchenwait_remadecanceledconfirmedcooked

Ejemplo: confirmed

payment_statusstring (OrderPayment)

Estado de pago: no pagado, pendiente, pagado

Valores:not_paidwaitingpaid

delivery_methodstring (OrderDelivery)

Método de entrega: courier o pickup

Valores:courierpickup

Respuestas

OK

object
statusstringobligatorio

Valores:successerror

Ejemplo: success

dataobject
filtersobject
date_creation_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_creation_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_creation_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

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

promo_codeobject (FilterInput)
valuestring

Ejemplo: example

typestringobligatorio

Ejemplo: integer or string

placeholderstring

Ejemplo: string

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

typeobject (FilterEnum)

Filtro-enumeración: una lista plana de valores de enumeración

valuestring

Ejemplo: example

typestringobligatorio

Ejemplo: select

optionarray of string
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

special_offer_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

platformobject (FilterEnum)

Filtro-enumeración: una lista plana de valores de enumeración

valuestring

Ejemplo: example

typestringobligatorio

Ejemplo: select

optionarray of string
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

order_statusobject (FilterEnum)

Filtro-enumeración: una lista plana de valores de enumeración

valuestring

Ejemplo: example

typestringobligatorio

Ejemplo: select

optionarray of string
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

payment_statusobject (FilterEnum)

Filtro-enumeración: una lista plana de valores de enumeración

valuestring

Ejemplo: example

typestringobligatorio

Ejemplo: select

optionarray of string
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

delivery_methodobject (FilterEnum)

Filtro-enumeración: una lista plana de valores de enumeración

valuestring

Ejemplo: example

typestringobligatorio

Ejemplo: select

optionarray of string
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

totalobject (SpecialOffersAnalyticsValues)
countintegerobligatorio

Ejemplo: 412

sumnumberobligatorio

Ejemplo: 531420.5

averagenumberobligatorio

Ejemplo: 1289.86

completed_countintegerobligatorio

Pedidos que han alcanzado el estado done o confirmed

Ejemplo: 379

completed_sharenumberobligatorio

Porcentaje de pedidos completados dentro de esta mitad

Ejemplo: 91.99

share_of_countnumberobligatorio

Porcentaje de todos los pedidos del período

Ejemplo: 34.2

share_of_sumnumberobligatorio

Ejemplo: 29.7

segmentsarray of object
keystringobligatorio

Qué significa mitad. Si se selecciona un código promocional, tipo de promoción o una promoción específica, la primera mitad se restringe y el par se convierte en matched_filter y rest; el denominador en cualquier caso son todos los pedidos del período. Determine la mitad por key, no por posición.

Valores:with_promo_codewithout_promo_codematched_filterrest

Ejemplo: with_promo_code

valuesobject (SpecialOffersAnalyticsValues) obligatorio
countintegerobligatorio

Ejemplo: 412

sumnumberobligatorio

Ejemplo: 531420.5

averagenumberobligatorio

Ejemplo: 1289.86

completed_countintegerobligatorio

Pedidos que han alcanzado el estado done o confirmed

Ejemplo: 379

completed_sharenumberobligatorio

Porcentaje de pedidos completados dentro de esta mitad

Ejemplo: 91.99

share_of_countnumberobligatorio

Porcentaje de todos los pedidos del período

Ejemplo: 34.2

share_of_sumnumberobligatorio

Ejemplo: 29.7

differenceobject

La primera mitad menos la segunda, en valores absolutos; las proporciones se restan en puntos porcentuales

countinteger

Ejemplo: -284

sumnumber

Ejemplo: -412300.1

averagenumber

Ejemplo: 180.4

completed_sharenumber

Ejemplo: -3.11