API

Ottenere l'analisi delle promozioni

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

Autorizzazione

api-token + language + role

Parametri della richiesta

date_creation_fromstring

Esempio: 25/04/2024

date_creation_tostring

Esempio: 26/04/2024

chain_idinteger
branch_idinteger
promo_codestring

Esempio: SALE20

typestring

Esempio: percent_discount_on_all_order

special_offer_idinteger

Esempio: 152410

platformstring (OrderPlatform)

Piattaforma di ordinazione

Valori:androidapifbiosvksite

order_statusstring (OrderStatus)

Stato dell'ordine: in consegna, completato, in preparazione, in cucina, non elaborato, pronto per la spedizione, in attesa di invio in cucina, in attesa di rifacimento, annullato, confermato, preparato

Valori:in_transitdoneassemblyin_kitchennot_processedready_to_transitwait_to_kitchenwait_remadecanceledconfirmedcooked

Esempio: confirmed

payment_statusstring (OrderPayment)

Stato del pagamento: non pagato, in attesa, pagato

Valori:not_paidwaitingpaid

delivery_methodstring (OrderDelivery)

Metodo di consegna: corriere o ritiro in sede

Valori:courierpickup

Risposte

OK

object
statusstringobbligatorio

Valori:successerror

Esempio: success

dataobject
filtersobject
date_creation_fromobject (FilterDateFrom)
valuestringpuò essere nullo

Esempio: 2026-08-01 00:00:00

typestringobbligatorio

Esempio: date

modestring (FilterMode)

Come l'interfaccia gestisce il filtro; un filtro normale non ha mode.
force_shown — sempre visibile, non può essere nascosto.
value_required — punto di ingresso nella sezione: sempre visibile, non può avere valore vuoto (finché non viene selezionato un valore, la lista è vuota; non esiste l'opzione "tutti"), il reset generale non lo azzera.

Valori:force_shownvalue_required

Esempio: value_required

date_creation_toobject (FilterDateTo)
valuestringpuò essere nullo

Esempio: 2026-08-31 23:59:59

typestringobbligatorio

Esempio: date

modestring (FilterMode)

Come l'interfaccia gestisce il filtro; un filtro normale non ha mode.
force_shown — sempre visibile, non può essere nascosto.
value_required — punto di ingresso nella sezione: sempre visibile, non può avere valore vuoto (finché non viene selezionato un valore, la lista è vuota; non esiste l'opzione "tutti"), il reset generale non lo azzera.

Valori:force_shownvalue_required

Esempio: value_required

date_creation_rangeobject (FilterDateRange)

Periodi predefiniti per il filtro data; il limite inferiore è calcolato nel fuso orario dell’utente. value indica il periodo corrispondente agli attuali *_from e *_to; null indica un periodo personalizzato. default è il periodo che il server inserisce nella richiesta senza date: viene applicato al primo caricamento della sezione e al reset. Il limite superiore del periodo corrisponde sempre al giorno attuale dell’utente, quindi option non lo include: non è necessario trasmettere *_to per un periodo predefinito, il server lo imposta automaticamente. Un periodo superiore a un anno viene troncato dal lato più recente.

valuestring (DateRange) può essere nullo

Periodo di filtro data predefinito. Non ha un proprio parametro di richiesta: il limite inferiore viene già calcolato in option e inserito in *_from. Il limite superiore non viene trasmesso né nella risposta né nella richiesta: è sempre uguale al giorno corrente dell’utente e viene impostato dal server.

Valori:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Esempio: today

defaultstring (DateRange) obbligatorio

Periodo di filtro data predefinito. Non ha un proprio parametro di richiesta: il limite inferiore viene già calcolato in option e inserito in *_from. Il limite superiore non viene trasmesso né nella risposta né nella richiesta: è sempre uguale al giorno corrente dell’utente e viene impostato dal server.

Valori:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Esempio: today

typestringobbligatorio

Esempio: select

modestring (FilterMode)

Come l'interfaccia gestisce il filtro; un filtro normale non ha mode.
force_shown — sempre visibile, non può essere nascosto.
value_required — punto di ingresso nella sezione: sempre visibile, non può avere valore vuoto (finché non viene selezionato un valore, la lista è vuota; non esiste l'opzione "tutti"), il reset generale non lo azzera.

Valori:force_shownvalue_required

Esempio: value_required

optionarray of objectobbligatorio
valuestring (DateRange) obbligatorio

Periodo di filtro data predefinito. Non ha un proprio parametro di richiesta: il limite inferiore viene già calcolato in option e inserito in *_from. Il limite superiore non viene trasmesso né nella risposta né nella richiesta: è sempre uguale al giorno corrente dell’utente e viene impostato dal server.

Valori:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Esempio: today

date_fromstringobbligatorio

Esempio: 25/08/2026

chain_idobject (FilterSelectInteger)
valueinteger

Esempio: 8920

typestringobbligatorio

Esempio: select

optionarray of object
valueintegerobbligatorio

Esempio: 8920

namestringobbligatorio

Esempio: Green Basket | Kaliningrad

modestring (FilterMode)

Come l'interfaccia gestisce il filtro; un filtro normale non ha mode.
force_shown — sempre visibile, non può essere nascosto.
value_required — punto di ingresso nella sezione: sempre visibile, non può avere valore vuoto (finché non viene selezionato un valore, la lista è vuota; non esiste l'opzione "tutti"), il reset generale non lo azzera.

Valori:force_shownvalue_required

Esempio: value_required

branch_idobject (FilterSelectInteger)
valueinteger

Esempio: 8920

typestringobbligatorio

Esempio: select

optionarray of object
valueintegerobbligatorio

Esempio: 8920

namestringobbligatorio

Esempio: Green Basket | Kaliningrad

modestring (FilterMode)

Come l'interfaccia gestisce il filtro; un filtro normale non ha mode.
force_shown — sempre visibile, non può essere nascosto.
value_required — punto di ingresso nella sezione: sempre visibile, non può avere valore vuoto (finché non viene selezionato un valore, la lista è vuota; non esiste l'opzione "tutti"), il reset generale non lo azzera.

Valori:force_shownvalue_required

Esempio: value_required

promo_codeobject (FilterInput)
valuestring

Esempio: example

typestringobbligatorio

Esempio: integer or string

placeholderstring

Esempio: string

modestring (FilterMode)

Come l'interfaccia gestisce il filtro; un filtro normale non ha mode.
force_shown — sempre visibile, non può essere nascosto.
value_required — punto di ingresso nella sezione: sempre visibile, non può avere valore vuoto (finché non viene selezionato un valore, la lista è vuota; non esiste l'opzione "tutti"), il reset generale non lo azzera.

Valori:force_shownvalue_required

Esempio: value_required

typeobject (FilterEnum)

Filtro enumerazione: elenco piatto di valori enumerati

valuestring

Esempio: example

typestringobbligatorio

Esempio: select

optionarray of string
modestring (FilterMode)

Come l'interfaccia gestisce il filtro; un filtro normale non ha mode.
force_shown — sempre visibile, non può essere nascosto.
value_required — punto di ingresso nella sezione: sempre visibile, non può avere valore vuoto (finché non viene selezionato un valore, la lista è vuota; non esiste l'opzione "tutti"), il reset generale non lo azzera.

Valori:force_shownvalue_required

Esempio: value_required

special_offer_idobject (FilterSelectInteger)
valueinteger

Esempio: 8920

typestringobbligatorio

Esempio: select

optionarray of object
valueintegerobbligatorio

Esempio: 8920

namestringobbligatorio

Esempio: Green Basket | Kaliningrad

modestring (FilterMode)

Come l'interfaccia gestisce il filtro; un filtro normale non ha mode.
force_shown — sempre visibile, non può essere nascosto.
value_required — punto di ingresso nella sezione: sempre visibile, non può avere valore vuoto (finché non viene selezionato un valore, la lista è vuota; non esiste l'opzione "tutti"), il reset generale non lo azzera.

Valori:force_shownvalue_required

Esempio: value_required

platformobject (FilterEnum)

Filtro enumerazione: elenco piatto di valori enumerati

valuestring

Esempio: example

typestringobbligatorio

Esempio: select

optionarray of string
modestring (FilterMode)

Come l'interfaccia gestisce il filtro; un filtro normale non ha mode.
force_shown — sempre visibile, non può essere nascosto.
value_required — punto di ingresso nella sezione: sempre visibile, non può avere valore vuoto (finché non viene selezionato un valore, la lista è vuota; non esiste l'opzione "tutti"), il reset generale non lo azzera.

Valori:force_shownvalue_required

Esempio: value_required

order_statusobject (FilterEnum)

Filtro enumerazione: elenco piatto di valori enumerati

valuestring

Esempio: example

typestringobbligatorio

Esempio: select

optionarray of string
modestring (FilterMode)

Come l'interfaccia gestisce il filtro; un filtro normale non ha mode.
force_shown — sempre visibile, non può essere nascosto.
value_required — punto di ingresso nella sezione: sempre visibile, non può avere valore vuoto (finché non viene selezionato un valore, la lista è vuota; non esiste l'opzione "tutti"), il reset generale non lo azzera.

Valori:force_shownvalue_required

Esempio: value_required

payment_statusobject (FilterEnum)

Filtro enumerazione: elenco piatto di valori enumerati

valuestring

Esempio: example

typestringobbligatorio

Esempio: select

optionarray of string
modestring (FilterMode)

Come l'interfaccia gestisce il filtro; un filtro normale non ha mode.
force_shown — sempre visibile, non può essere nascosto.
value_required — punto di ingresso nella sezione: sempre visibile, non può avere valore vuoto (finché non viene selezionato un valore, la lista è vuota; non esiste l'opzione "tutti"), il reset generale non lo azzera.

Valori:force_shownvalue_required

Esempio: value_required

delivery_methodobject (FilterEnum)

Filtro enumerazione: elenco piatto di valori enumerati

valuestring

Esempio: example

typestringobbligatorio

Esempio: select

optionarray of string
modestring (FilterMode)

Come l'interfaccia gestisce il filtro; un filtro normale non ha mode.
force_shown — sempre visibile, non può essere nascosto.
value_required — punto di ingresso nella sezione: sempre visibile, non può avere valore vuoto (finché non viene selezionato un valore, la lista è vuota; non esiste l'opzione "tutti"), il reset generale non lo azzera.

Valori:force_shownvalue_required

Esempio: value_required

totalobject (SpecialOffersAnalyticsValues)
countintegerobbligatorio

Esempio: 412

sumnumberobbligatorio

Esempio: 531420.5

averagenumberobbligatorio

Esempio: 1289.86

completed_countintegerobbligatorio

Ordini che hanno raggiunto lo stato done o confirmed

Esempio: 379

completed_sharenumberobbligatorio

Percentuale di ordini completati all'interno di questa metà

Esempio: 91.99

share_of_countnumberobbligatorio

Quota su tutti gli ordini del periodo, in percentuale

Esempio: 34.2

share_of_sumnumberobbligatorio

Esempio: 29.7

segmentsarray of object
keystringobbligatorio

Cosa significa metà. Se viene selezionato un codice promozionale, un tipo di promozione o una promozione specifica, la prima metà si restringe e la coppia diventa matched_filter e rest; il denominatore in ogni caso è costituito da tutti gli ordini del periodo. Determinare la metà tramite key, non tramite la posizione.

Valori:with_promo_codewithout_promo_codematched_filterrest

Esempio: with_promo_code

valuesobject (SpecialOffersAnalyticsValues) obbligatorio
countintegerobbligatorio

Esempio: 412

sumnumberobbligatorio

Esempio: 531420.5

averagenumberobbligatorio

Esempio: 1289.86

completed_countintegerobbligatorio

Ordini che hanno raggiunto lo stato done o confirmed

Esempio: 379

completed_sharenumberobbligatorio

Percentuale di ordini completati all'interno di questa metà

Esempio: 91.99

share_of_countnumberobbligatorio

Quota su tutti gli ordini del periodo, in percentuale

Esempio: 34.2

share_of_sumnumberobbligatorio

Esempio: 29.7

differenceobject

La prima metà meno la seconda, in valori assoluti; le quote vengono sottratte in punti percentuali

countinteger

Esempio: -284

sumnumber

Esempio: -412300.1

averagenumber

Esempio: 180.4

completed_sharenumber

Esempio: -3.11