API

Obtenir l’analytique des offres spéciales

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

Autorisation

api-token + language + role

Paramètres de requête

date_creation_fromstring

Exemple: 25/04/2024

date_creation_tostring

Exemple: 26/04/2024

chain_idinteger
branch_idinteger
promo_codestring

Exemple: SALE20

typestring

Exemple: percent_discount_on_all_order

special_offer_idinteger

Exemple: 152410

platformstring (OrderPlatform)

Plateforme de commande

Valeurs:androidapifbiosvksite

order_statusstring (OrderStatus)

Statut de la commande : en cours de livraison, terminé, en préparation, en cuisine, non traité, prêt à être expédié, en attente d'envoi en cuisine, en attente de reprise, annulé, confirmé, préparé

Valeurs:in_transitdoneassemblyin_kitchennot_processedready_to_transitwait_to_kitchenwait_remadecanceledconfirmedcooked

Exemple: confirmed

payment_statusstring (OrderPayment)

Statut du paiement : non payé, en attente, payé

Valeurs:not_paidwaitingpaid

delivery_methodstring (OrderDelivery)

Mode de livraison : coursier ou retrait sur place

Valeurs:courierpickup

Réponses

OK

object
statusstringobligatoire

Valeurs:successerror

Exemple: success

dataobject
filtersobject
date_creation_fromobject (FilterDateFrom)
valuestringpeut être nul

Exemple: 2026-08-01 00:00:00

typestringobligatoire

Exemple: date

modestring (FilterMode)

Comment l’interface gère le filtre ; un filtre classique n’a pas de champ mode.
force_shown — toujours affiché, ne peut pas être masqué.
value_required — point d’entrée dans la section : toujours affiché, ne peut pas être vide (tant qu’aucune valeur n’est sélectionnée, la liste est vide ; il n’y a pas d’option « tout »), la réinitialisation générale ne l’efface pas.

Valeurs:force_shownvalue_required

Exemple: value_required

date_creation_toobject (FilterDateTo)
valuestringpeut être nul

Exemple: 2026-08-31 23:59:59

typestringobligatoire

Exemple: date

modestring (FilterMode)

Comment l’interface gère le filtre ; un filtre classique n’a pas de champ mode.
force_shown — toujours affiché, ne peut pas être masqué.
value_required — point d’entrée dans la section : toujours affiché, ne peut pas être vide (tant qu’aucune valeur n’est sélectionnée, la liste est vide ; il n’y a pas d’option « tout »), la réinitialisation générale ne l’efface pas.

Valeurs:force_shownvalue_required

Exemple: value_required

date_creation_rangeobject (FilterDateRange)

Périodes prédéfinies pour le filtre de date ; la limite inférieure est calculée selon le fuseau horaire de l'utilisateur. value — période correspondant aux valeurs actuelles de *_from et *_to ; null — période personnalisée. default — période que le serveur applique à une requête sans dates : elle est également utilisée lors du premier chargement de la section et lors de la réinitialisation. La limite supérieure de la période correspond toujours au jour actuel de l'utilisateur, c'est pourquoi option ne la contient pas : il n'est pas nécessaire de transmettre *_to pour une période prédéfinie, le serveur la définit automatiquement. Une période de plus d'un an est tronquée du côté de la limite la plus récente.

valuestring (DateRange) peut être nul

Période de filtre de date prédéfinie. Ce schéma n'a pas de paramètre de requête propre : la limite inférieure est déjà calculée dans option et utilisée dans *_from. La limite supérieure n'est transmise ni dans la réponse, ni dans la requête — elle correspond toujours au jour actuel de l'utilisateur et est définie par le serveur.

Valeurs:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Exemple: today

defaultstring (DateRange) obligatoire

Période de filtre de date prédéfinie. Ce schéma n'a pas de paramètre de requête propre : la limite inférieure est déjà calculée dans option et utilisée dans *_from. La limite supérieure n'est transmise ni dans la réponse, ni dans la requête — elle correspond toujours au jour actuel de l'utilisateur et est définie par le serveur.

Valeurs:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Exemple: today

typestringobligatoire

Exemple: select

modestring (FilterMode)

Comment l’interface gère le filtre ; un filtre classique n’a pas de champ mode.
force_shown — toujours affiché, ne peut pas être masqué.
value_required — point d’entrée dans la section : toujours affiché, ne peut pas être vide (tant qu’aucune valeur n’est sélectionnée, la liste est vide ; il n’y a pas d’option « tout »), la réinitialisation générale ne l’efface pas.

Valeurs:force_shownvalue_required

Exemple: value_required

optionarray of objectobligatoire
valuestring (DateRange) obligatoire

Période de filtre de date prédéfinie. Ce schéma n'a pas de paramètre de requête propre : la limite inférieure est déjà calculée dans option et utilisée dans *_from. La limite supérieure n'est transmise ni dans la réponse, ni dans la requête — elle correspond toujours au jour actuel de l'utilisateur et est définie par le serveur.

Valeurs:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Exemple: today

date_fromstringobligatoire

Exemple: 25/08/2026

chain_idobject (FilterSelectInteger)
valueinteger

Exemple: 8920

typestringobligatoire

Exemple: select

optionarray of object
valueintegerobligatoire

Exemple: 8920

namestringobligatoire

Exemple: Green Basket | Kaliningrad

modestring (FilterMode)

Comment l’interface gère le filtre ; un filtre classique n’a pas de champ mode.
force_shown — toujours affiché, ne peut pas être masqué.
value_required — point d’entrée dans la section : toujours affiché, ne peut pas être vide (tant qu’aucune valeur n’est sélectionnée, la liste est vide ; il n’y a pas d’option « tout »), la réinitialisation générale ne l’efface pas.

Valeurs:force_shownvalue_required

Exemple: value_required

branch_idobject (FilterSelectInteger)
valueinteger

Exemple: 8920

typestringobligatoire

Exemple: select

optionarray of object
valueintegerobligatoire

Exemple: 8920

namestringobligatoire

Exemple: Green Basket | Kaliningrad

modestring (FilterMode)

Comment l’interface gère le filtre ; un filtre classique n’a pas de champ mode.
force_shown — toujours affiché, ne peut pas être masqué.
value_required — point d’entrée dans la section : toujours affiché, ne peut pas être vide (tant qu’aucune valeur n’est sélectionnée, la liste est vide ; il n’y a pas d’option « tout »), la réinitialisation générale ne l’efface pas.

Valeurs:force_shownvalue_required

Exemple: value_required

promo_codeobject (FilterInput)
valuestring

Exemple: example

typestringobligatoire

Exemple: integer or string

placeholderstring

Exemple: string

modestring (FilterMode)

Comment l’interface gère le filtre ; un filtre classique n’a pas de champ mode.
force_shown — toujours affiché, ne peut pas être masqué.
value_required — point d’entrée dans la section : toujours affiché, ne peut pas être vide (tant qu’aucune valeur n’est sélectionnée, la liste est vide ; il n’y a pas d’option « tout »), la réinitialisation générale ne l’efface pas.

Valeurs:force_shownvalue_required

Exemple: value_required

typeobject (FilterEnum)

Filtre d’énumération — liste plate de valeurs d’énumération

valuestring

Exemple: example

typestringobligatoire

Exemple: select

optionarray of string
modestring (FilterMode)

Comment l’interface gère le filtre ; un filtre classique n’a pas de champ mode.
force_shown — toujours affiché, ne peut pas être masqué.
value_required — point d’entrée dans la section : toujours affiché, ne peut pas être vide (tant qu’aucune valeur n’est sélectionnée, la liste est vide ; il n’y a pas d’option « tout »), la réinitialisation générale ne l’efface pas.

Valeurs:force_shownvalue_required

Exemple: value_required

special_offer_idobject (FilterSelectInteger)
valueinteger

Exemple: 8920

typestringobligatoire

Exemple: select

optionarray of object
valueintegerobligatoire

Exemple: 8920

namestringobligatoire

Exemple: Green Basket | Kaliningrad

modestring (FilterMode)

Comment l’interface gère le filtre ; un filtre classique n’a pas de champ mode.
force_shown — toujours affiché, ne peut pas être masqué.
value_required — point d’entrée dans la section : toujours affiché, ne peut pas être vide (tant qu’aucune valeur n’est sélectionnée, la liste est vide ; il n’y a pas d’option « tout »), la réinitialisation générale ne l’efface pas.

Valeurs:force_shownvalue_required

Exemple: value_required

platformobject (FilterEnum)

Filtre d’énumération — liste plate de valeurs d’énumération

valuestring

Exemple: example

typestringobligatoire

Exemple: select

optionarray of string
modestring (FilterMode)

Comment l’interface gère le filtre ; un filtre classique n’a pas de champ mode.
force_shown — toujours affiché, ne peut pas être masqué.
value_required — point d’entrée dans la section : toujours affiché, ne peut pas être vide (tant qu’aucune valeur n’est sélectionnée, la liste est vide ; il n’y a pas d’option « tout »), la réinitialisation générale ne l’efface pas.

Valeurs:force_shownvalue_required

Exemple: value_required

order_statusobject (FilterEnum)

Filtre d’énumération — liste plate de valeurs d’énumération

valuestring

Exemple: example

typestringobligatoire

Exemple: select

optionarray of string
modestring (FilterMode)

Comment l’interface gère le filtre ; un filtre classique n’a pas de champ mode.
force_shown — toujours affiché, ne peut pas être masqué.
value_required — point d’entrée dans la section : toujours affiché, ne peut pas être vide (tant qu’aucune valeur n’est sélectionnée, la liste est vide ; il n’y a pas d’option « tout »), la réinitialisation générale ne l’efface pas.

Valeurs:force_shownvalue_required

Exemple: value_required

payment_statusobject (FilterEnum)

Filtre d’énumération — liste plate de valeurs d’énumération

valuestring

Exemple: example

typestringobligatoire

Exemple: select

optionarray of string
modestring (FilterMode)

Comment l’interface gère le filtre ; un filtre classique n’a pas de champ mode.
force_shown — toujours affiché, ne peut pas être masqué.
value_required — point d’entrée dans la section : toujours affiché, ne peut pas être vide (tant qu’aucune valeur n’est sélectionnée, la liste est vide ; il n’y a pas d’option « tout »), la réinitialisation générale ne l’efface pas.

Valeurs:force_shownvalue_required

Exemple: value_required

delivery_methodobject (FilterEnum)

Filtre d’énumération — liste plate de valeurs d’énumération

valuestring

Exemple: example

typestringobligatoire

Exemple: select

optionarray of string
modestring (FilterMode)

Comment l’interface gère le filtre ; un filtre classique n’a pas de champ mode.
force_shown — toujours affiché, ne peut pas être masqué.
value_required — point d’entrée dans la section : toujours affiché, ne peut pas être vide (tant qu’aucune valeur n’est sélectionnée, la liste est vide ; il n’y a pas d’option « tout »), la réinitialisation générale ne l’efface pas.

Valeurs:force_shownvalue_required

Exemple: value_required

totalobject (SpecialOffersAnalyticsValues)
countintegerobligatoire

Exemple: 412

sumnumberobligatoire

Exemple: 531420.5

averagenumberobligatoire

Exemple: 1289.86

completed_countintegerobligatoire

Commandes ayant atteint le statut done ou confirmed

Exemple: 379

completed_sharenumberobligatoire

Part des commandes terminées dans cette moitié, en pourcentage

Exemple: 91.99

share_of_countnumberobligatoire

Part du nombre total de commandes sur la période, en pourcentage

Exemple: 34.2

share_of_sumnumberobligatoire

Exemple: 29.7

segmentsarray of object
keystringobligatoire

Que signifie moitié. Si un code promo, un type d’offre ou une offre spécifique est sélectionné, la première moitié est réduite, et la paire devient matched_filter et rest ; le dénominateur reste dans tous les cas l’ensemble des commandes de la période. Déterminez la moitié selon la valeur de key, et non selon la position.

Valeurs:with_promo_codewithout_promo_codematched_filterrest

Exemple: with_promo_code

valuesobject (SpecialOffersAnalyticsValues) obligatoire
countintegerobligatoire

Exemple: 412

sumnumberobligatoire

Exemple: 531420.5

averagenumberobligatoire

Exemple: 1289.86

completed_countintegerobligatoire

Commandes ayant atteint le statut done ou confirmed

Exemple: 379

completed_sharenumberobligatoire

Part des commandes terminées dans cette moitié, en pourcentage

Exemple: 91.99

share_of_countnumberobligatoire

Part du nombre total de commandes sur la période, en pourcentage

Exemple: 34.2

share_of_sumnumberobligatoire

Exemple: 29.7

differenceobject

Première moitié moins la seconde, en valeurs absolues ; les parts sont soustraites en points de pourcentage

countinteger

Exemple: -284

sumnumber

Exemple: -412300.1

averagenumber

Exemple: 180.4

completed_sharenumber

Exemple: -3.11