API

Získat statistiky

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

Autorizace

api-token + language + role

Parametry dotazu

date_creation_fromstring

Příklad: 29/04/2022

date_creation_tostring
account_idinteger
chain_idinteger
branch_idinteger
city_idinteger
affiliate_idinteger
operator_idinteger
all_zonesboolean

Příklad: true

Odpovědi

OK

object
statusstringpovinné

Hodnoty:successerror

Příklad: success

dataobject
filtersobject
date_creation_fromobject (FilterDateFrom)
valuestringmůže být null

Příklad: 2026-08-01 00:00:00

typestringpovinné

Příklad: date

modestring (FilterMode)

Jak rozhraní zpracovává filtr; běžný filtr nemá mode. force_shown — vždy zobrazen, nelze skrýt. value_required — vstupní bod do sekce: vždy zobrazen, nemůže mít prázdnou hodnotu (dokud není vybrána hodnota, seznam je prázdný; varianta „vše“ není k dispozici), globální reset jej nevymaže.

Hodnoty:force_shownvalue_required

Příklad: value_required

date_creation_toobject (FilterDateTo)
valuestringmůže být null

Příklad: 2026-08-31 23:59:59

typestringpovinné

Příklad: date

modestring (FilterMode)

Jak rozhraní zpracovává filtr; běžný filtr nemá mode. force_shown — vždy zobrazen, nelze skrýt. value_required — vstupní bod do sekce: vždy zobrazen, nemůže mít prázdnou hodnotu (dokud není vybrána hodnota, seznam je prázdný; varianta „vše“ není k dispozici), globální reset jej nevymaže.

Hodnoty:force_shownvalue_required

Příklad: value_required

date_creation_rangeobject (FilterDateRange)

Přednastavená období filtru podle data; dolní hranice je vypočítána v časovém pásmu uživatele. value — období, kterému odpovídají aktuální *_from a *_to; null — vlastní období. default — období, které server nastaví v požadavku bez dat: použije se také při prvním načtení sekce a při resetování. Horní hranice období je vždy rovna aktuálnímu dni uživatele, proto ji option neobsahuje: pro přednastavené období není třeba předávat *_to, server ji nastaví sám. Období delší než jeden rok je zkráceno na straně novější hranice.

valuestring (DateRange) může být null

Předdefinované období filtru podle data. Nemá vlastní parametr dotazu: dolní hranice je již vypočítána v option a je použita v *_from. Horní hranice není vrácena v odpovědi ani odeslána v dotazu — vždy odpovídá aktuálnímu dni uživatele a je nastavena serverem.

Hodnoty:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Příklad: today

defaultstring (DateRange) povinné

Předdefinované období filtru podle data. Nemá vlastní parametr dotazu: dolní hranice je již vypočítána v option a je použita v *_from. Horní hranice není vrácena v odpovědi ani odeslána v dotazu — vždy odpovídá aktuálnímu dni uživatele a je nastavena serverem.

Hodnoty:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Příklad: today

typestringpovinné

Příklad: select

modestring (FilterMode)

Jak rozhraní zpracovává filtr; běžný filtr nemá mode. force_shown — vždy zobrazen, nelze skrýt. value_required — vstupní bod do sekce: vždy zobrazen, nemůže mít prázdnou hodnotu (dokud není vybrána hodnota, seznam je prázdný; varianta „vše“ není k dispozici), globální reset jej nevymaže.

Hodnoty:force_shownvalue_required

Příklad: value_required

optionarray of objectpovinné
valuestring (DateRange) povinné

Předdefinované období filtru podle data. Nemá vlastní parametr dotazu: dolní hranice je již vypočítána v option a je použita v *_from. Horní hranice není vrácena v odpovědi ani odeslána v dotazu — vždy odpovídá aktuálnímu dni uživatele a je nastavena serverem.

Hodnoty:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Příklad: today

date_fromstringpovinné

Příklad: 25/08/2026

chain_idobject (FilterSelectInteger)
valueinteger

Příklad: 8920

typestringpovinné

Příklad: select

optionarray of object
valueintegerpovinné

Příklad: 8920

namestringpovinné

Příklad: Green Basket | Kaliningrad

modestring (FilterMode)

Jak rozhraní zpracovává filtr; běžný filtr nemá mode. force_shown — vždy zobrazen, nelze skrýt. value_required — vstupní bod do sekce: vždy zobrazen, nemůže mít prázdnou hodnotu (dokud není vybrána hodnota, seznam je prázdný; varianta „vše“ není k dispozici), globální reset jej nevymaže.

Hodnoty:force_shownvalue_required

Příklad: value_required

branch_idobject (FilterSelectInteger)
valueinteger

Příklad: 8920

typestringpovinné

Příklad: select

optionarray of object
valueintegerpovinné

Příklad: 8920

namestringpovinné

Příklad: Green Basket | Kaliningrad

modestring (FilterMode)

Jak rozhraní zpracovává filtr; běžný filtr nemá mode. force_shown — vždy zobrazen, nelze skrýt. value_required — vstupní bod do sekce: vždy zobrazen, nemůže mít prázdnou hodnotu (dokud není vybrána hodnota, seznam je prázdný; varianta „vše“ není k dispozici), globální reset jej nevymaže.

Hodnoty:force_shownvalue_required

Příklad: value_required

operator_idobject (FilterSelectInteger)
valueinteger

Příklad: 8920

typestringpovinné

Příklad: select

optionarray of object
valueintegerpovinné

Příklad: 8920

namestringpovinné

Příklad: Green Basket | Kaliningrad

modestring (FilterMode)

Jak rozhraní zpracovává filtr; běžný filtr nemá mode. force_shown — vždy zobrazen, nelze skrýt. value_required — vstupní bod do sekce: vždy zobrazen, nemůže mít prázdnou hodnotu (dokud není vybrána hodnota, seznam je prázdný; varianta „vše“ není k dispozici), globální reset jej nevymaže.

Hodnoty:force_shownvalue_required

Příklad: value_required

Jedna z možností
count_download_appsobject
apps_iosintegerpovinné

Příklad: 7

apps_androidintegerpovinné

Příklad: 7

count_ordersobject
confirmedintegerpovinné

Příklad: 100

canceledintegerpovinné

Příklad: 10

not_processedintegerpovinné

Příklad: 1

count_orders_by_platformarray of object
platformstringpovinné

Hodnoty:siteiosandroidvkfbapitotal

Příklad: site

valueintegerpovinné

Příklad: 100

statuses_timesarray of object
startstringpovinné

Hodnoty:in_transitdonenot_processedconfirmedcanceledready_to_transitin_kitchenassemblycooked

Příklad: in_transit

endstringpovinné

Hodnoty:in_transitdonenot_processedconfirmedcanceledready_to_transitin_kitchenassemblycooked

Příklad: done

valueintegerpovinné

Příklad: 348656

sumsarray of object
platformstringpovinné

Hodnoty:siteiosandroidvkfbtotal

Příklad: site

valuenumberpovinné

Příklad: 1000000

commissionsarray of object
platformstringpovinné

Hodnoty:siteiosandroidvkfbtotal

Příklad: site

valuenumberpovinné

Příklad: 10000

popular_itemsarray of object
namestringpovinné

Příklad: Ramen with tempura shrimp - 300 g

countintegerpovinné

Příklad: 100