API

Gauti statistiką

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

Autorizacija

api-token + language + role

Užklausos parametrai

date_creation_fromstring

Pavyzdys: 29/04/2022

date_creation_tostring
account_idinteger
chain_idinteger
branch_idinteger
city_idinteger
affiliate_idinteger
operator_idinteger
all_zonesboolean

Pavyzdys: true

Atsakymai

OK

object
statusstringprivalomas

Reikšmės:successerror

Pavyzdys: success

dataobject
filtersobject
date_creation_fromobject (FilterDateFrom)
valuestringgali būti null

Pavyzdys: 2026-08-01 00:00:00

typestringprivalomas

Pavyzdys: date

modestring (FilterMode)

Kaip sąsaja apdoroja filtrą; paprastam filtrui mode nėra. force_shown — visada rodomas, paslėpti negalima. value_required — įėjimo taškas į skyrių: visada rodomas, neturi tuščios reikšmės (kol reikšmė nepasirinkta, sąrašas tuščias; varianto „visi“ nėra), bendras atstatymas jo neišvalo.

Reikšmės:force_shownvalue_required

Pavyzdys: value_required

date_creation_toobject (FilterDateTo)
valuestringgali būti null

Pavyzdys: 2026-08-31 23:59:59

typestringprivalomas

Pavyzdys: date

modestring (FilterMode)

Kaip sąsaja apdoroja filtrą; paprastam filtrui mode nėra. force_shown — visada rodomas, paslėpti negalima. value_required — įėjimo taškas į skyrių: visada rodomas, neturi tuščios reikšmės (kol reikšmė nepasirinkta, sąrašas tuščias; varianto „visi“ nėra), bendras atstatymas jo neišvalo.

Reikšmės:force_shownvalue_required

Pavyzdys: value_required

date_creation_rangeobject (FilterDateRange)

Paruošti datos filtro laikotarpiai; apatinė riba apskaičiuojama pagal naudotojo laiko juostą. value — laikotarpis, kuriam atitinka dabartiniai *_from ir *_to; null — pasirinktinis laikotarpis. default — laikotarpis, kurį serveris naudoja užklausoje be datų: jis taip pat taikomas pirmą kartą įkėlus skyrių ir grąžinamas atstatant nustatymus. Viršutinė laikotarpio riba visada lygi dabartinei naudotojo dienai, todėl option jos neturi: perduoti *_to paruoštam laikotarpiui nereikia, serveris ją nustato automatiškai. Laikotarpis, ilgesnis nei metai, nukerpamas nuo naujesnės ribos.

valuestring (DateRange) gali būti null

Paruoštas datos filtro laikotarpis. Neturi atskiro užklausos parametro: apatinė riba jau apskaičiuota ir perduodama per option, įrašoma į *_from. Viršutinė riba neperduodama nei atsakyme, nei užklausoje — ji visada lygi dabartinei naudotojo dienai ir nustatoma serverio.

Reikšmės:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Pavyzdys: today

defaultstring (DateRange) privalomas

Paruoštas datos filtro laikotarpis. Neturi atskiro užklausos parametro: apatinė riba jau apskaičiuota ir perduodama per option, įrašoma į *_from. Viršutinė riba neperduodama nei atsakyme, nei užklausoje — ji visada lygi dabartinei naudotojo dienai ir nustatoma serverio.

Reikšmės:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Pavyzdys: today

typestringprivalomas

Pavyzdys: select

modestring (FilterMode)

Kaip sąsaja apdoroja filtrą; paprastam filtrui mode nėra. force_shown — visada rodomas, paslėpti negalima. value_required — įėjimo taškas į skyrių: visada rodomas, neturi tuščios reikšmės (kol reikšmė nepasirinkta, sąrašas tuščias; varianto „visi“ nėra), bendras atstatymas jo neišvalo.

Reikšmės:force_shownvalue_required

Pavyzdys: value_required

optionarray of objectprivalomas
valuestring (DateRange) privalomas

Paruoštas datos filtro laikotarpis. Neturi atskiro užklausos parametro: apatinė riba jau apskaičiuota ir perduodama per option, įrašoma į *_from. Viršutinė riba neperduodama nei atsakyme, nei užklausoje — ji visada lygi dabartinei naudotojo dienai ir nustatoma serverio.

Reikšmės:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Pavyzdys: today

date_fromstringprivalomas

Pavyzdys: 25/08/2026

chain_idobject (FilterSelectInteger)
valueinteger

Pavyzdys: 8920

typestringprivalomas

Pavyzdys: select

optionarray of object
valueintegerprivalomas

Pavyzdys: 8920

namestringprivalomas

Pavyzdys: Green Basket | Kaliningrad

modestring (FilterMode)

Kaip sąsaja apdoroja filtrą; paprastam filtrui mode nėra. force_shown — visada rodomas, paslėpti negalima. value_required — įėjimo taškas į skyrių: visada rodomas, neturi tuščios reikšmės (kol reikšmė nepasirinkta, sąrašas tuščias; varianto „visi“ nėra), bendras atstatymas jo neišvalo.

Reikšmės:force_shownvalue_required

Pavyzdys: value_required

branch_idobject (FilterSelectInteger)
valueinteger

Pavyzdys: 8920

typestringprivalomas

Pavyzdys: select

optionarray of object
valueintegerprivalomas

Pavyzdys: 8920

namestringprivalomas

Pavyzdys: Green Basket | Kaliningrad

modestring (FilterMode)

Kaip sąsaja apdoroja filtrą; paprastam filtrui mode nėra. force_shown — visada rodomas, paslėpti negalima. value_required — įėjimo taškas į skyrių: visada rodomas, neturi tuščios reikšmės (kol reikšmė nepasirinkta, sąrašas tuščias; varianto „visi“ nėra), bendras atstatymas jo neišvalo.

Reikšmės:force_shownvalue_required

Pavyzdys: value_required

operator_idobject (FilterSelectInteger)
valueinteger

Pavyzdys: 8920

typestringprivalomas

Pavyzdys: select

optionarray of object
valueintegerprivalomas

Pavyzdys: 8920

namestringprivalomas

Pavyzdys: Green Basket | Kaliningrad

modestring (FilterMode)

Kaip sąsaja apdoroja filtrą; paprastam filtrui mode nėra. force_shown — visada rodomas, paslėpti negalima. value_required — įėjimo taškas į skyrių: visada rodomas, neturi tuščios reikšmės (kol reikšmė nepasirinkta, sąrašas tuščias; varianto „visi“ nėra), bendras atstatymas jo neišvalo.

Reikšmės:force_shownvalue_required

Pavyzdys: value_required

Vienas iš variantų
count_download_appsobject
apps_iosintegerprivalomas

Pavyzdys: 7

apps_androidintegerprivalomas

Pavyzdys: 7

count_ordersobject
confirmedintegerprivalomas

Pavyzdys: 100

canceledintegerprivalomas

Pavyzdys: 10

not_processedintegerprivalomas

Pavyzdys: 1

count_orders_by_platformarray of object
platformstringprivalomas

Reikšmės:siteiosandroidvkfbapitotal

Pavyzdys: site

valueintegerprivalomas

Pavyzdys: 100

statuses_timesarray of object
startstringprivalomas

Reikšmės:in_transitdonenot_processedconfirmedcanceledready_to_transitin_kitchenassemblycooked

Pavyzdys: in_transit

endstringprivalomas

Reikšmės:in_transitdonenot_processedconfirmedcanceledready_to_transitin_kitchenassemblycooked

Pavyzdys: done

valueintegerprivalomas

Pavyzdys: 348656

sumsarray of object
platformstringprivalomas

Reikšmės:siteiosandroidvkfbtotal

Pavyzdys: site

valuenumberprivalomas

Pavyzdys: 1000000

commissionsarray of object
platformstringprivalomas

Reikšmės:siteiosandroidvkfbtotal

Pavyzdys: site

valuenumberprivalomas

Pavyzdys: 10000

popular_itemsarray of object
namestringprivalomas

Pavyzdys: Ramen with tempura shrimp - 300 g

countintegerprivalomas

Pavyzdys: 100