API

Statistika hankimine

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

Autoriseerimine

api-token + language + role

Päringu parameetrid

date_creation_fromstring

Näide: 29/04/2022

date_creation_tostring
account_idinteger
chain_idinteger
branch_idinteger
city_idinteger
affiliate_idinteger
operator_idinteger
all_zonesboolean

Näide: true

Vastused

OK

object
statusstringkohustuslik

Väärtused:successerror

Näide: success

dataobject
filtersobject
date_creation_fromobject (FilterDateFrom)
valuestringvõib olla null

Näide: 2026-08-01 00:00:00

typestringkohustuslik

Näide: date

modestring (FilterMode)

Kuidas liides töötleb filtrit; tavalisel filtril pole mode. force_shown — alati kuvatud, peita ei saa. value_required — sektsiooni sisenemispunkt: alati kuvatud, ei saa olla tühja väärtust (kuni väärtus pole valitud, loend on tühi; valikut „kõik” pole), üldine lähtestamine seda ei tühjenda.

Väärtused:force_shownvalue_required

Näide: value_required

date_creation_toobject (FilterDateTo)
valuestringvõib olla null

Näide: 2026-08-31 23:59:59

typestringkohustuslik

Näide: date

modestring (FilterMode)

Kuidas liides töötleb filtrit; tavalisel filtril pole mode. force_shown — alati kuvatud, peita ei saa. value_required — sektsiooni sisenemispunkt: alati kuvatud, ei saa olla tühja väärtust (kuni väärtus pole valitud, loend on tühi; valikut „kõik” pole), üldine lähtestamine seda ei tühjenda.

Väärtused:force_shownvalue_required

Näide: value_required

date_creation_rangeobject (FilterDateRange)

Valmis kuupäevafiltri perioodid; alumine piir arvutatakse kasutaja ajavööndi järgi. value — periood, millele vastavad praegused *_from ja *_to; null — suvaline periood. default — periood, mille server lisab päringusse ilma kuupäevadeta: seda kasutatakse ka jaotise esmasel laadimisel ning lähtestamisel. Perioodi ülemine piir on alati kasutaja tänane päev, seetõttu option seda ei sisalda: valmisperioodi puhul pole vaja *_to edastada, server määrab selle ise. Üle aasta pikkune periood kärbitakse uuema piiri poolt.

valuestring (DateRange) võib olla null

Valmis kuupäevafiltri periood. Sellel ei ole oma päringuparameetrit: alumine piir arvutatakse ette ja edastatakse option kaudu ning kasutatakse väljal *_from. Ülemist piiri ei edastata vastuses ega päringus — see on alati võrdne kasutaja jooksva kuupäevaga ja määratakse serveri poolt.

Väärtused:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Näide: today

defaultstring (DateRange) kohustuslik

Valmis kuupäevafiltri periood. Sellel ei ole oma päringuparameetrit: alumine piir arvutatakse ette ja edastatakse option kaudu ning kasutatakse väljal *_from. Ülemist piiri ei edastata vastuses ega päringus — see on alati võrdne kasutaja jooksva kuupäevaga ja määratakse serveri poolt.

Väärtused:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Näide: today

typestringkohustuslik

Näide: select

modestring (FilterMode)

Kuidas liides töötleb filtrit; tavalisel filtril pole mode. force_shown — alati kuvatud, peita ei saa. value_required — sektsiooni sisenemispunkt: alati kuvatud, ei saa olla tühja väärtust (kuni väärtus pole valitud, loend on tühi; valikut „kõik” pole), üldine lähtestamine seda ei tühjenda.

Väärtused:force_shownvalue_required

Näide: value_required

optionarray of objectkohustuslik
valuestring (DateRange) kohustuslik

Valmis kuupäevafiltri periood. Sellel ei ole oma päringuparameetrit: alumine piir arvutatakse ette ja edastatakse option kaudu ning kasutatakse väljal *_from. Ülemist piiri ei edastata vastuses ega päringus — see on alati võrdne kasutaja jooksva kuupäevaga ja määratakse serveri poolt.

Väärtused:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Näide: today

date_fromstringkohustuslik

Näide: 25/08/2026

chain_idobject (FilterSelectInteger)
valueinteger

Näide: 8920

typestringkohustuslik

Näide: select

optionarray of object
valueintegerkohustuslik

Näide: 8920

namestringkohustuslik

Näide: Green Basket | Kaliningrad

modestring (FilterMode)

Kuidas liides töötleb filtrit; tavalisel filtril pole mode. force_shown — alati kuvatud, peita ei saa. value_required — sektsiooni sisenemispunkt: alati kuvatud, ei saa olla tühja väärtust (kuni väärtus pole valitud, loend on tühi; valikut „kõik” pole), üldine lähtestamine seda ei tühjenda.

Väärtused:force_shownvalue_required

Näide: value_required

branch_idobject (FilterSelectInteger)
valueinteger

Näide: 8920

typestringkohustuslik

Näide: select

optionarray of object
valueintegerkohustuslik

Näide: 8920

namestringkohustuslik

Näide: Green Basket | Kaliningrad

modestring (FilterMode)

Kuidas liides töötleb filtrit; tavalisel filtril pole mode. force_shown — alati kuvatud, peita ei saa. value_required — sektsiooni sisenemispunkt: alati kuvatud, ei saa olla tühja väärtust (kuni väärtus pole valitud, loend on tühi; valikut „kõik” pole), üldine lähtestamine seda ei tühjenda.

Väärtused:force_shownvalue_required

Näide: value_required

operator_idobject (FilterSelectInteger)
valueinteger

Näide: 8920

typestringkohustuslik

Näide: select

optionarray of object
valueintegerkohustuslik

Näide: 8920

namestringkohustuslik

Näide: Green Basket | Kaliningrad

modestring (FilterMode)

Kuidas liides töötleb filtrit; tavalisel filtril pole mode. force_shown — alati kuvatud, peita ei saa. value_required — sektsiooni sisenemispunkt: alati kuvatud, ei saa olla tühja väärtust (kuni väärtus pole valitud, loend on tühi; valikut „kõik” pole), üldine lähtestamine seda ei tühjenda.

Väärtused:force_shownvalue_required

Näide: value_required

Üks variantidest
count_download_appsobject
apps_iosintegerkohustuslik

Näide: 7

apps_androidintegerkohustuslik

Näide: 7

count_ordersobject
confirmedintegerkohustuslik

Näide: 100

canceledintegerkohustuslik

Näide: 10

not_processedintegerkohustuslik

Näide: 1

count_orders_by_platformarray of object
platformstringkohustuslik

Väärtused:siteiosandroidvkfbapitotal

Näide: site

valueintegerkohustuslik

Näide: 100

statuses_timesarray of object
startstringkohustuslik

Väärtused:in_transitdonenot_processedconfirmedcanceledready_to_transitin_kitchenassemblycooked

Näide: in_transit

endstringkohustuslik

Väärtused:in_transitdonenot_processedconfirmedcanceledready_to_transitin_kitchenassemblycooked

Näide: done

valueintegerkohustuslik

Näide: 348656

sumsarray of object
platformstringkohustuslik

Väärtused:siteiosandroidvkfbtotal

Näide: site

valuenumberkohustuslik

Näide: 1000000

commissionsarray of object
platformstringkohustuslik

Väärtused:siteiosandroidvkfbtotal

Näide: site

valuenumberkohustuslik

Näide: 10000

popular_itemsarray of object
namestringkohustuslik

Näide: Ramen with tempura shrimp - 300 g

countintegerkohustuslik

Näide: 100