API

Obter estatísticas

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

Autorização

api-token + language + role

Parâmetros de consulta

date_creation_fromstring

Exemplo: 29/04/2022

date_creation_tostring
account_idinteger
chain_idinteger
branch_idinteger
city_idinteger
affiliate_idinteger
operator_idinteger
all_zonesboolean

Exemplo: true

Respostas

OK

object
statusstringobrigatório

Valores:successerror

Exemplo: success

dataobject
filtersobject
date_creation_fromobject (FilterDateFrom)
valuestringpode ser nulo

Exemplo: 2026-08-01 00:00:00

typestringobrigatório

Exemplo: date

modestring (FilterMode)

Como a interface processa o filtro; filtros comuns não possuem mode. force_shown — sempre exibido, não pode ser ocultado. value_required — ponto de entrada para a seção: sempre exibido, não pode ter valor vazio (enquanto o valor não for selecionado, a lista permanece vazia; não há opção "todos"), a limpeza geral não o redefine.

Valores:force_shownvalue_required

Exemplo: value_required

date_creation_toobject (FilterDateTo)
valuestringpode ser nulo

Exemplo: 2026-08-31 23:59:59

typestringobrigatório

Exemplo: date

modestring (FilterMode)

Como a interface processa o filtro; filtros comuns não possuem mode. force_shown — sempre exibido, não pode ser ocultado. value_required — ponto de entrada para a seção: sempre exibido, não pode ter valor vazio (enquanto o valor não for selecionado, a lista permanece vazia; não há opção "todos"), a limpeza geral não o redefine.

Valores:force_shownvalue_required

Exemplo: value_required

date_creation_rangeobject (FilterDateRange)

Períodos prontos para filtro de data; o limite inferior é calculado no fuso horário do usuário. value — período correspondente aos atuais *_from e *_to; null — período personalizado. default — período que o servidor insere na requisição sem datas: também é aplicado no primeiro carregamento da seção e ao redefinir o filtro. O limite superior do período é sempre igual ao dia atual do usuário, por isso option não o inclui: não é necessário enviar *_to para um período pronto, o servidor define automaticamente. Períodos com duração superior a um ano são cortados no limite mais recente.

valuestring (DateRange) pode ser nulo

Período de filtro de data pré-definido. Não possui parâmetro de consulta próprio: o limite inferior já vem calculado em option e é inserido em *_from. O limite superior não é enviado nem na resposta, nem na solicitação — ele é sempre igual ao dia atual do usuário e é definido pelo servidor.

Valores:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Exemplo: today

defaultstring (DateRange) obrigatório

Período de filtro de data pré-definido. Não possui parâmetro de consulta próprio: o limite inferior já vem calculado em option e é inserido em *_from. O limite superior não é enviado nem na resposta, nem na solicitação — ele é sempre igual ao dia atual do usuário e é definido pelo servidor.

Valores:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Exemplo: today

typestringobrigatório

Exemplo: select

modestring (FilterMode)

Como a interface processa o filtro; filtros comuns não possuem mode. force_shown — sempre exibido, não pode ser ocultado. value_required — ponto de entrada para a seção: sempre exibido, não pode ter valor vazio (enquanto o valor não for selecionado, a lista permanece vazia; não há opção "todos"), a limpeza geral não o redefine.

Valores:force_shownvalue_required

Exemplo: value_required

optionarray of objectobrigatório
valuestring (DateRange) obrigatório

Período de filtro de data pré-definido. Não possui parâmetro de consulta próprio: o limite inferior já vem calculado em option e é inserido em *_from. O limite superior não é enviado nem na resposta, nem na solicitação — ele é sempre igual ao dia atual do usuário e é definido pelo servidor.

Valores:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Exemplo: today

date_fromstringobrigatório

Exemplo: 25/08/2026

chain_idobject (FilterSelectInteger)
valueinteger

Exemplo: 8920

typestringobrigatório

Exemplo: select

optionarray of object
valueintegerobrigatório

Exemplo: 8920

namestringobrigatório

Exemplo: Green Basket | Kaliningrad

modestring (FilterMode)

Como a interface processa o filtro; filtros comuns não possuem mode. force_shown — sempre exibido, não pode ser ocultado. value_required — ponto de entrada para a seção: sempre exibido, não pode ter valor vazio (enquanto o valor não for selecionado, a lista permanece vazia; não há opção "todos"), a limpeza geral não o redefine.

Valores:force_shownvalue_required

Exemplo: value_required

branch_idobject (FilterSelectInteger)
valueinteger

Exemplo: 8920

typestringobrigatório

Exemplo: select

optionarray of object
valueintegerobrigatório

Exemplo: 8920

namestringobrigatório

Exemplo: Green Basket | Kaliningrad

modestring (FilterMode)

Como a interface processa o filtro; filtros comuns não possuem mode. force_shown — sempre exibido, não pode ser ocultado. value_required — ponto de entrada para a seção: sempre exibido, não pode ter valor vazio (enquanto o valor não for selecionado, a lista permanece vazia; não há opção "todos"), a limpeza geral não o redefine.

Valores:force_shownvalue_required

Exemplo: value_required

operator_idobject (FilterSelectInteger)
valueinteger

Exemplo: 8920

typestringobrigatório

Exemplo: select

optionarray of object
valueintegerobrigatório

Exemplo: 8920

namestringobrigatório

Exemplo: Green Basket | Kaliningrad

modestring (FilterMode)

Como a interface processa o filtro; filtros comuns não possuem mode. force_shown — sempre exibido, não pode ser ocultado. value_required — ponto de entrada para a seção: sempre exibido, não pode ter valor vazio (enquanto o valor não for selecionado, a lista permanece vazia; não há opção "todos"), a limpeza geral não o redefine.

Valores:force_shownvalue_required

Exemplo: value_required

Uma das opções
count_download_appsobject
apps_iosintegerobrigatório

Exemplo: 7

apps_androidintegerobrigatório

Exemplo: 7

count_ordersobject
confirmedintegerobrigatório

Exemplo: 100

canceledintegerobrigatório

Exemplo: 10

not_processedintegerobrigatório

Exemplo: 1

count_orders_by_platformarray of object
platformstringobrigatório

Valores:siteiosandroidvkfbapitotal

Exemplo: site

valueintegerobrigatório

Exemplo: 100

statuses_timesarray of object
startstringobrigatório

Valores:in_transitdonenot_processedconfirmedcanceledready_to_transitin_kitchenassemblycooked

Exemplo: in_transit

endstringobrigatório

Valores:in_transitdonenot_processedconfirmedcanceledready_to_transitin_kitchenassemblycooked

Exemplo: done

valueintegerobrigatório

Exemplo: 348656

sumsarray of object
platformstringobrigatório

Valores:siteiosandroidvkfbtotal

Exemplo: site

valuenumberobrigatório

Exemplo: 1000000

commissionsarray of object
platformstringobrigatório

Valores:siteiosandroidvkfbtotal

Exemplo: site

valuenumberobrigatório

Exemplo: 10000

popular_itemsarray of object
namestringobrigatório

Exemplo: Ramen with tempura shrimp - 300 g

countintegerobrigatório

Exemplo: 100