API

Ottenere statistiche

GET/api/crm/v2/statisticsv2
operationId: statistics.default

Autorizzazione

api-token + language + role

Parametri della richiesta

date_creation_fromstring

Esempio: 29/04/2022

date_creation_tostring
account_idinteger
chain_idinteger
branch_idinteger
city_idinteger
affiliate_idinteger
operator_idinteger
all_zonesboolean

Esempio: true

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

operator_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

Una delle opzioni
count_download_appsobject
apps_iosintegerobbligatorio

Esempio: 7

apps_androidintegerobbligatorio

Esempio: 7

count_ordersobject
confirmedintegerobbligatorio

Esempio: 100

canceledintegerobbligatorio

Esempio: 10

not_processedintegerobbligatorio

Esempio: 1

count_orders_by_platformarray of object
platformstringobbligatorio

Valori:siteiosandroidvkfbapitotal

Esempio: site

valueintegerobbligatorio

Esempio: 100

statuses_timesarray of object
startstringobbligatorio

Valori:in_transitdonenot_processedconfirmedcanceledready_to_transitin_kitchenassemblycooked

Esempio: in_transit

endstringobbligatorio

Valori:in_transitdonenot_processedconfirmedcanceledready_to_transitin_kitchenassemblycooked

Esempio: done

valueintegerobbligatorio

Esempio: 348656

sumsarray of object
platformstringobbligatorio

Valori:siteiosandroidvkfbtotal

Esempio: site

valuenumberobbligatorio

Esempio: 1000000

commissionsarray of object
platformstringobbligatorio

Valori:siteiosandroidvkfbtotal

Esempio: site

valuenumberobbligatorio

Esempio: 10000

popular_itemsarray of object
namestringobbligatorio

Esempio: Ramen with tempura shrimp - 300 g

countintegerobbligatorio

Esempio: 100