API

Získat statistiky pro prodejní kanály

GET/api/crm/v2/sales_channelsv2
operationId: salesChannels.default

Vrací tržby, počet objednávek a průměrnou útratu pro každý prodejní kanál. Na jeden požadavek lze získat data až za dvě období pro porovnání měsíců. Souhrny za období jsou již vypočítané, pro grafy jsou vráceny pouze neprázdné hodiny v UTC. Převádějte je do časového pásma uživatele a agregujte podle dnů nebo měsíců. Do tržeb jsou zahrnuty pouze dokončené objednávky.

Autorizace

api-token + language + role

Parametry dotazu

date_creation_fromstring

Příklad: 01/08/2026

date_creation_tostring

Příklad: 31/08/2026

date_comparison_fromstring

Druhé období; prázdné, pokud není s čím porovnávat

Příklad: 01/07/2026

date_comparison_tostring

Příklad: 31/07/2026

chain_idinteger
branch_idinteger
delivery_methodstring (OrderDelivery)

Způsob doručení: kurýr nebo osobní odběr

Hodnoty:courierpickup

payment_statusstring (OrderPayment)

Stav platby: nezaplaceno, čeká, zaplaceno

Hodnoty:not_paidwaitingpaid

operator_idinteger
downloadstring

Vrací souhrnnou tabulku za období A ve formátu CSV místo JSON

Hodnoty:yes

Příklad: yes

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

date_comparison_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_comparison_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_comparison_rangeobject (FilterDateRangeOptional)

Přednastavená období filtrování dat bez výchozí hodnoty: default je vždy null.

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) 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

typestringpovinné

Příklad: select

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

delivery_methodobject (FilterEnum)

Filtr-enum — plochý seznam hodnot výčtu

valuestring

Příklad: example

typestringpovinné

Příklad: select

optionarray of string
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

payment_statusobject (FilterEnum)

Filtr-enum — plochý seznam hodnot výčtu

valuestring

Příklad: example

typestringpovinné

Příklad: select

optionarray of string
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

downloadobject (FilterButtonDownloadCsv)

Tlačítko pro stažení výběru: při kliknutí předejte download=yes

valuestring

Příklad: Download

typestringpovinné

Příklad: button_download_csv

periodsarray of object

Jeden prvek na období; druhý pouze pokud je zadáno porovnávací období

keystringpovinné

a — hlavní období, b — porovnávací období

Hodnoty:ab

Příklad: a

date_fromstringpovinné

Příklad: 01/08/2026

date_tostringpovinné

Příklad: 31/08/2026

totalobject (SalesChannelsTotal) povinné

Souhrn období podle všech kanálů

orders_countintegerpovinné

Příklad: 4120

completed_countintegerpovinné

Příklad: 3894

completed_percentnumberpovinné

Příklad: 94.51

revenuenumberpovinné

Příklad: 4361280

averagenumberpovinné

Příklad: 1120

channelsarray of objectpovinné

Jeden prvek pro každý kanál s objednávkami, ve pevném pořadí. Prvek „všechny kanály“ není přítomen: pro tento účel slouží total.

platformstring (OrderPlatform) povinné

Objednávková platforma

Hodnoty:androidapifbiosvksite

orders_countintegerpovinné

Příklad: 1810

orders_sharenumberpovinné

Podíl objednávek za období v procentech

Příklad: 43.93

completed_countintegerpovinné

Příklad: 1702

completed_percentnumberpovinné

Příklad: 94.03

revenuenumberpovinné

Příklad: 1855180

revenue_sharenumberpovinné

Podíl tržeb za období v procentech

Příklad: 42.54

averagenumberpovinné

Tržby dělené počtem dokončených objednávek

Příklad: 1090

deltaobject (SalesChannelsDelta) povinnémůže být null

Porovnání kanálu se stejným kanálem v období B. null, pokud období B není zadáno.

revenue_absolutenumberpovinné

Příklad: -120400

revenue_percentnumberpovinnémůže být null

null, pokud v období B neměl kanál žádné tržby: procentuální růst z nuly neexistuje

Příklad: -6.09

bucketsarray of objectpovinné

Objednávky seskupené podle hodin; pouze neprázdné hodiny. Nejprve převeďte čas do časového pásma uživatele, poté seskupte hodiny do bodů grafu: spojnicový graf — podle dnů nebo měsíců, sloupcový graf — podle kalendářních měsíců. Sčítejte hodnoty count, completed_count a revenue; neprůměrujte průměrné hodnoty.

datetimestringpovinné

Čas, ke kterému se vztahují objednávky, v UTC

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

countintegerpovinné

Příklad: 12

completed_countintegerpovinné

Příklad: 11

revenuenumberpovinné

Příklad: 12100