API

Pobierz statystyki

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

Autoryzacja

api-token + language + role

Parametry zapytania

date_creation_fromstring

Przykład: 29/04/2022

date_creation_tostring
account_idinteger
chain_idinteger
branch_idinteger
city_idinteger
affiliate_idinteger
operator_idinteger
all_zonesboolean

Przykład: true

Odpowiedzi

OK

object
statusstringwymagane

Wartości:successerror

Przykład: success

dataobject
filtersobject
date_creation_fromobject (FilterDateFrom)
valuestringmoże być null

Przykład: 2026-08-01 00:00:00

typestringwymagane

Przykład: date

modestring (FilterMode)

Jak interfejs obsługuje filtr; zwykły filtr nie ma mode. force_shown — zawsze widoczny, nie można ukryć. value_required — punkt wejścia do sekcji: zawsze widoczny, nie może mieć pustej wartości (dopóki wartość nie zostanie wybrana, lista jest pusta; nie ma opcji „wszystko”), ogólne resetowanie go nie czyści.

Wartości:force_shownvalue_required

Przykład: value_required

date_creation_toobject (FilterDateTo)
valuestringmoże być null

Przykład: 2026-08-31 23:59:59

typestringwymagane

Przykład: date

modestring (FilterMode)

Jak interfejs obsługuje filtr; zwykły filtr nie ma mode. force_shown — zawsze widoczny, nie można ukryć. value_required — punkt wejścia do sekcji: zawsze widoczny, nie może mieć pustej wartości (dopóki wartość nie zostanie wybrana, lista jest pusta; nie ma opcji „wszystko”), ogólne resetowanie go nie czyści.

Wartości:force_shownvalue_required

Przykład: value_required

date_creation_rangeobject (FilterDateRange)

Gotowe okresy filtrowania według daty; dolna granica jest obliczana w strefie czasowej użytkownika. value — okres, któremu odpowiadają bieżące *_from i *_to; null — dowolny okres. default — okres, który serwer ustawia w zapytaniu bez dat: jest stosowany przy pierwszym ładowaniu sekcji oraz po resecie. Górna granica okresu zawsze odpowiada bieżącemu dniu użytkownika, dlatego option jej nie zawiera: nie trzeba przekazywać *_to dla gotowego okresu, serwer ustawia ją samodzielnie. Okres dłuższy niż rok jest obcinany od najnowszej granicy.

valuestring (DateRange) może być null

Gotowy zakres dat do filtrowania. Nie posiada własnego parametru zapytania: dolna granica jest już obliczona i przekazywana w option, a następnie podstawiana do *_from. Górna granica nie jest przekazywana ani w odpowiedzi, ani w zapytaniu — zawsze jest równa bieżącemu dniu użytkownika i ustalana przez serwer.

Wartości:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Przykład: today

defaultstring (DateRange) wymagane

Gotowy zakres dat do filtrowania. Nie posiada własnego parametru zapytania: dolna granica jest już obliczona i przekazywana w option, a następnie podstawiana do *_from. Górna granica nie jest przekazywana ani w odpowiedzi, ani w zapytaniu — zawsze jest równa bieżącemu dniu użytkownika i ustalana przez serwer.

Wartości:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Przykład: today

typestringwymagane

Przykład: select

modestring (FilterMode)

Jak interfejs obsługuje filtr; zwykły filtr nie ma mode. force_shown — zawsze widoczny, nie można ukryć. value_required — punkt wejścia do sekcji: zawsze widoczny, nie może mieć pustej wartości (dopóki wartość nie zostanie wybrana, lista jest pusta; nie ma opcji „wszystko”), ogólne resetowanie go nie czyści.

Wartości:force_shownvalue_required

Przykład: value_required

optionarray of objectwymagane
valuestring (DateRange) wymagane

Gotowy zakres dat do filtrowania. Nie posiada własnego parametru zapytania: dolna granica jest już obliczona i przekazywana w option, a następnie podstawiana do *_from. Górna granica nie jest przekazywana ani w odpowiedzi, ani w zapytaniu — zawsze jest równa bieżącemu dniu użytkownika i ustalana przez serwer.

Wartości:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Przykład: today

date_fromstringwymagane

Przykład: 25/08/2026

chain_idobject (FilterSelectInteger)
valueinteger

Przykład: 8920

typestringwymagane

Przykład: select

optionarray of object
valueintegerwymagane

Przykład: 8920

namestringwymagane

Przykład: Green Basket | Kaliningrad

modestring (FilterMode)

Jak interfejs obsługuje filtr; zwykły filtr nie ma mode. force_shown — zawsze widoczny, nie można ukryć. value_required — punkt wejścia do sekcji: zawsze widoczny, nie może mieć pustej wartości (dopóki wartość nie zostanie wybrana, lista jest pusta; nie ma opcji „wszystko”), ogólne resetowanie go nie czyści.

Wartości:force_shownvalue_required

Przykład: value_required

branch_idobject (FilterSelectInteger)
valueinteger

Przykład: 8920

typestringwymagane

Przykład: select

optionarray of object
valueintegerwymagane

Przykład: 8920

namestringwymagane

Przykład: Green Basket | Kaliningrad

modestring (FilterMode)

Jak interfejs obsługuje filtr; zwykły filtr nie ma mode. force_shown — zawsze widoczny, nie można ukryć. value_required — punkt wejścia do sekcji: zawsze widoczny, nie może mieć pustej wartości (dopóki wartość nie zostanie wybrana, lista jest pusta; nie ma opcji „wszystko”), ogólne resetowanie go nie czyści.

Wartości:force_shownvalue_required

Przykład: value_required

operator_idobject (FilterSelectInteger)
valueinteger

Przykład: 8920

typestringwymagane

Przykład: select

optionarray of object
valueintegerwymagane

Przykład: 8920

namestringwymagane

Przykład: Green Basket | Kaliningrad

modestring (FilterMode)

Jak interfejs obsługuje filtr; zwykły filtr nie ma mode. force_shown — zawsze widoczny, nie można ukryć. value_required — punkt wejścia do sekcji: zawsze widoczny, nie może mieć pustej wartości (dopóki wartość nie zostanie wybrana, lista jest pusta; nie ma opcji „wszystko”), ogólne resetowanie go nie czyści.

Wartości:force_shownvalue_required

Przykład: value_required

Jeden z wariantów
count_download_appsobject
apps_iosintegerwymagane

Przykład: 7

apps_androidintegerwymagane

Przykład: 7

count_ordersobject
confirmedintegerwymagane

Przykład: 100

canceledintegerwymagane

Przykład: 10

not_processedintegerwymagane

Przykład: 1

count_orders_by_platformarray of object
platformstringwymagane

Wartości:siteiosandroidvkfbapitotal

Przykład: site

valueintegerwymagane

Przykład: 100

statuses_timesarray of object
startstringwymagane

Wartości:in_transitdonenot_processedconfirmedcanceledready_to_transitin_kitchenassemblycooked

Przykład: in_transit

endstringwymagane

Wartości:in_transitdonenot_processedconfirmedcanceledready_to_transitin_kitchenassemblycooked

Przykład: done

valueintegerwymagane

Przykład: 348656

sumsarray of object
platformstringwymagane

Wartości:siteiosandroidvkfbtotal

Przykład: site

valuenumberwymagane

Przykład: 1000000

commissionsarray of object
platformstringwymagane

Wartości:siteiosandroidvkfbtotal

Przykład: site

valuenumberwymagane

Przykład: 10000

popular_itemsarray of object
namestringwymagane

Przykład: Ramen with tempura shrimp - 300 g

countintegerwymagane

Przykład: 100