API

Iegūt pārdošanas kanālu statistiku

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

Atgriež ieņēmumus, pasūtījumu skaitu un vidējo čeku katram pārdošanas kanālam. Vienā pieprasījumā var atgriezt līdz diviem periodiem, lai salīdzinātu mēnesi ar mēnesi. Perioda kopsavilkumi jau ir aprēķināti, bet grafikiem tiek atgriezti tikai ne-tukšie stundas dati UTC laika joslā. Pārvērtiet tos lietotāja laika joslā un apkopojiet pa dienām vai mēnešiem. Ieņēmumos tiek iekļauti tikai izpildītie pasūtījumi.

Autorizācija

api-token + language + role

Vaicājuma parametri

date_creation_fromstring

Piemērs: 01/08/2026

date_creation_tostring

Piemērs: 31/08/2026

date_comparison_fromstring

Otrais periods; tukšs, ja nav ar ko salīdzināt

Piemērs: 01/07/2026

date_comparison_tostring

Piemērs: 31/07/2026

chain_idinteger
branch_idinteger
delivery_methodstring (OrderDelivery)

Piegādes veids: kurjers vai pašizņemšana

Vērtības:courierpickup

payment_statusstring (OrderPayment)

Apmaksas statuss: nav apmaksāts, gaida, apmaksāts

Vērtības:not_paidwaitingpaid

operator_idinteger
downloadstring

Atgriež perioda A kopsavilkuma tabulu CSV formātā, nevis JSON

Vērtības:yes

Piemērs: yes

Atbildes

OK

object
statusstringobligāts

Vērtības:successerror

Piemērs: success

dataobject
filtersobject
date_creation_fromobject (FilterDateFrom)
valuestringvar būt null

Piemērs: 2026-08-01 00:00:00

typestringobligāts

Piemērs: date

modestring (FilterMode)

Kā interfeiss apstrādā filtru; parastam filtram nav mode. force_shown — vienmēr tiek rādīts, nevar paslēpt. value_required — sadaļas ieejas punkts: vienmēr tiek rādīts, nevar būt tukša vērtība (kamēr vērtība nav izvēlēta, saraksts ir tukšs; nav varianta "visi"), kopējā atiestatīšana to neiztīra.

Vērtības:force_shownvalue_required

Piemērs: value_required

date_creation_toobject (FilterDateTo)
valuestringvar būt null

Piemērs: 2026-08-31 23:59:59

typestringobligāts

Piemērs: date

modestring (FilterMode)

Kā interfeiss apstrādā filtru; parastam filtram nav mode. force_shown — vienmēr tiek rādīts, nevar paslēpt. value_required — sadaļas ieejas punkts: vienmēr tiek rādīts, nevar būt tukša vērtība (kamēr vērtība nav izvēlēta, saraksts ir tukšs; nav varianta "visi"), kopējā atiestatīšana to neiztīra.

Vērtības:force_shownvalue_required

Piemērs: value_required

date_creation_rangeobject (FilterDateRange)

Gatavi datuma filtra periodi; apakšējā robeža tiek aprēķināta lietotāja laika joslā. value — periods, kuram atbilst pašreizējie *_from un *_to; null — patvaļīgs periods. default — periods, kuru serveris izmanto pieprasījumā bez datumiem: tas tiek piemērots arī sadaļas pirmajā ielādē un pie atiestatīšanas. Perioda augšējā robeža vienmēr ir vienāda ar lietotāja pašreizējo dienu, tāpēc option to nesatur: gatavam periodam nav jānosūta *_to, serveris to iestata pats. Periods, kas ir garāks par gadu, tiek apgriezts no svaigākās robežas puses.

valuestring (DateRange) var būt null

Gatavs datuma filtra periods. Tam nav sava vaicājuma parametra: apakšējā robeža jau ir aprēķināta option un tiek izmantota kā *_from. Augšējā robeža netiek nodota ne atbildē, ne vaicājumā — tā vienmēr ir vienāda ar lietotāja pašreizējo dienu un tiek noteikta serverī.

Vērtības:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Piemērs: today

defaultstring (DateRange) obligāts

Gatavs datuma filtra periods. Tam nav sava vaicājuma parametra: apakšējā robeža jau ir aprēķināta option un tiek izmantota kā *_from. Augšējā robeža netiek nodota ne atbildē, ne vaicājumā — tā vienmēr ir vienāda ar lietotāja pašreizējo dienu un tiek noteikta serverī.

Vērtības:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Piemērs: today

typestringobligāts

Piemērs: select

modestring (FilterMode)

Kā interfeiss apstrādā filtru; parastam filtram nav mode. force_shown — vienmēr tiek rādīts, nevar paslēpt. value_required — sadaļas ieejas punkts: vienmēr tiek rādīts, nevar būt tukša vērtība (kamēr vērtība nav izvēlēta, saraksts ir tukšs; nav varianta "visi"), kopējā atiestatīšana to neiztīra.

Vērtības:force_shownvalue_required

Piemērs: value_required

optionarray of objectobligāts
valuestring (DateRange) obligāts

Gatavs datuma filtra periods. Tam nav sava vaicājuma parametra: apakšējā robeža jau ir aprēķināta option un tiek izmantota kā *_from. Augšējā robeža netiek nodota ne atbildē, ne vaicājumā — tā vienmēr ir vienāda ar lietotāja pašreizējo dienu un tiek noteikta serverī.

Vērtības:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Piemērs: today

date_fromstringobligāts

Piemērs: 25/08/2026

date_comparison_fromobject (FilterDateFrom)
valuestringvar būt null

Piemērs: 2026-08-01 00:00:00

typestringobligāts

Piemērs: date

modestring (FilterMode)

Kā interfeiss apstrādā filtru; parastam filtram nav mode. force_shown — vienmēr tiek rādīts, nevar paslēpt. value_required — sadaļas ieejas punkts: vienmēr tiek rādīts, nevar būt tukša vērtība (kamēr vērtība nav izvēlēta, saraksts ir tukšs; nav varianta "visi"), kopējā atiestatīšana to neiztīra.

Vērtības:force_shownvalue_required

Piemērs: value_required

date_comparison_toobject (FilterDateTo)
valuestringvar būt null

Piemērs: 2026-08-31 23:59:59

typestringobligāts

Piemērs: date

modestring (FilterMode)

Kā interfeiss apstrādā filtru; parastam filtram nav mode. force_shown — vienmēr tiek rādīts, nevar paslēpt. value_required — sadaļas ieejas punkts: vienmēr tiek rādīts, nevar būt tukša vērtība (kamēr vērtība nav izvēlēta, saraksts ir tukšs; nav varianta "visi"), kopējā atiestatīšana to neiztīra.

Vērtības:force_shownvalue_required

Piemērs: value_required

date_comparison_rangeobject (FilterDateRangeOptional)

Gatavi datumu filtra periodi bez noklusējuma vērtības: default vienmēr ir null.

valuestring (DateRange) var būt null

Gatavs datuma filtra periods. Tam nav sava vaicājuma parametra: apakšējā robeža jau ir aprēķināta option un tiek izmantota kā *_from. Augšējā robeža netiek nodota ne atbildē, ne vaicājumā — tā vienmēr ir vienāda ar lietotāja pašreizējo dienu un tiek noteikta serverī.

Vērtības:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Piemērs: today

defaultstring (DateRange) var būt null

Gatavs datuma filtra periods. Tam nav sava vaicājuma parametra: apakšējā robeža jau ir aprēķināta option un tiek izmantota kā *_from. Augšējā robeža netiek nodota ne atbildē, ne vaicājumā — tā vienmēr ir vienāda ar lietotāja pašreizējo dienu un tiek noteikta serverī.

Vērtības:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Piemērs: today

typestringobligāts

Piemērs: select

optionarray of objectobligāts
valuestring (DateRange) obligāts

Gatavs datuma filtra periods. Tam nav sava vaicājuma parametra: apakšējā robeža jau ir aprēķināta option un tiek izmantota kā *_from. Augšējā robeža netiek nodota ne atbildē, ne vaicājumā — tā vienmēr ir vienāda ar lietotāja pašreizējo dienu un tiek noteikta serverī.

Vērtības:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Piemērs: today

date_fromstringobligāts

Piemērs: 25/08/2026

chain_idobject (FilterSelectInteger)
valueinteger

Piemērs: 8920

typestringobligāts

Piemērs: select

optionarray of object
valueintegerobligāts

Piemērs: 8920

namestringobligāts

Piemērs: Green Basket | Kaliningrad

modestring (FilterMode)

Kā interfeiss apstrādā filtru; parastam filtram nav mode. force_shown — vienmēr tiek rādīts, nevar paslēpt. value_required — sadaļas ieejas punkts: vienmēr tiek rādīts, nevar būt tukša vērtība (kamēr vērtība nav izvēlēta, saraksts ir tukšs; nav varianta "visi"), kopējā atiestatīšana to neiztīra.

Vērtības:force_shownvalue_required

Piemērs: value_required

branch_idobject (FilterSelectInteger)
valueinteger

Piemērs: 8920

typestringobligāts

Piemērs: select

optionarray of object
valueintegerobligāts

Piemērs: 8920

namestringobligāts

Piemērs: Green Basket | Kaliningrad

modestring (FilterMode)

Kā interfeiss apstrādā filtru; parastam filtram nav mode. force_shown — vienmēr tiek rādīts, nevar paslēpt. value_required — sadaļas ieejas punkts: vienmēr tiek rādīts, nevar būt tukša vērtība (kamēr vērtība nav izvēlēta, saraksts ir tukšs; nav varianta "visi"), kopējā atiestatīšana to neiztīra.

Vērtības:force_shownvalue_required

Piemērs: value_required

delivery_methodobject (FilterEnum)

Filtrs-enums — plakans uzskaitījuma vērtību saraksts

valuestring

Piemērs: example

typestringobligāts

Piemērs: select

optionarray of string
modestring (FilterMode)

Kā interfeiss apstrādā filtru; parastam filtram nav mode. force_shown — vienmēr tiek rādīts, nevar paslēpt. value_required — sadaļas ieejas punkts: vienmēr tiek rādīts, nevar būt tukša vērtība (kamēr vērtība nav izvēlēta, saraksts ir tukšs; nav varianta "visi"), kopējā atiestatīšana to neiztīra.

Vērtības:force_shownvalue_required

Piemērs: value_required

payment_statusobject (FilterEnum)

Filtrs-enums — plakans uzskaitījuma vērtību saraksts

valuestring

Piemērs: example

typestringobligāts

Piemērs: select

optionarray of string
modestring (FilterMode)

Kā interfeiss apstrādā filtru; parastam filtram nav mode. force_shown — vienmēr tiek rādīts, nevar paslēpt. value_required — sadaļas ieejas punkts: vienmēr tiek rādīts, nevar būt tukša vērtība (kamēr vērtība nav izvēlēta, saraksts ir tukšs; nav varianta "visi"), kopējā atiestatīšana to neiztīra.

Vērtības:force_shownvalue_required

Piemērs: value_required

operator_idobject (FilterSelectInteger)
valueinteger

Piemērs: 8920

typestringobligāts

Piemērs: select

optionarray of object
valueintegerobligāts

Piemērs: 8920

namestringobligāts

Piemērs: Green Basket | Kaliningrad

modestring (FilterMode)

Kā interfeiss apstrādā filtru; parastam filtram nav mode. force_shown — vienmēr tiek rādīts, nevar paslēpt. value_required — sadaļas ieejas punkts: vienmēr tiek rādīts, nevar būt tukša vērtība (kamēr vērtība nav izvēlēta, saraksts ir tukšs; nav varianta "visi"), kopējā atiestatīšana to neiztīra.

Vērtības:force_shownvalue_required

Piemērs: value_required

downloadobject (FilterButtonDownloadCsv)

Lejupielādes poga: nospiežot, pārsūtiet download=yes

valuestring

Piemērs: Download

typestringobligāts

Piemērs: button_download_csv

periodsarray of object

Viens elements uz periodu; otrs — tikai, ja ir norādīts salīdzināšanas periods

keystringobligāts

a — galvenais periods, b — salīdzināšanas periods

Vērtības:ab

Piemērs: a

date_fromstringobligāts

Piemērs: 01/08/2026

date_tostringobligāts

Piemērs: 31/08/2026

totalobject (SalesChannelsTotal) obligāts

Perioda kopsavilkums visiem kanāliem

orders_countintegerobligāts

Piemērs: 4120

completed_countintegerobligāts

Piemērs: 3894

completed_percentnumberobligāts

Piemērs: 94.51

revenuenumberobligāts

Piemērs: 4361280

averagenumberobligāts

Piemērs: 1120

channelsarray of objectobligāts

Viens elements katram kanālam ar pasūtījumiem, fiksētā secībā. Nav elementa "visi kanāli": tam ir total.

platformstring (OrderPlatform) obligāts

Pasūtījumu platforma

Vērtības:androidapifbiosvksite

orders_countintegerobligāts

Piemērs: 1810

orders_sharenumberobligāts

Perioda pasūtījumu daļa procentos

Piemērs: 43.93

completed_countintegerobligāts

Piemērs: 1702

completed_percentnumberobligāts

Piemērs: 94.03

revenuenumberobligāts

Piemērs: 1855180

revenue_sharenumberobligāts

Perioda ieņēmumu daļa procentos

Piemērs: 42.54

averagenumberobligāts

Ieņēmumi, dalīti ar izpildīto pasūtījumu skaitu

Piemērs: 1090

deltaobject (SalesChannelsDelta) obligātsvar būt null

Salīdzinājums ar to pašu kanālu periodā B. null, ja periods B nav norādīts.

revenue_absolutenumberobligāts

Piemērs: -120400

revenue_percentnumberobligātsvar būt null

null, ja kanālam periodā B nebija ieņēmumu: procentuālais pieaugums no nulles nav iespējams

Piemērs: -6.09

bucketsarray of objectobligāts

Pasūtījumi, grupēti pa stundām; tikai tās stundas, kurās ir dati. Pārvērtiet laiku lietotāja laika joslā, pēc tam apkopojiet stundas grafika punktos: līniju grafikam — pa dienām vai mēnešiem, stabiņu grafikam — pa kalendāra mēnešiem. Saskaitiet count, completed_count un revenue; nevidējiet vidējās vērtības.

datetimestringobligāts

Laiks, uz kuru attiecas pasūtījumi, UTC

Piemērs: 2026-08-01 09:00:00

countintegerobligāts

Piemērs: 12

completed_countintegerobligāts

Piemērs: 11

revenuenumberobligāts

Piemērs: 12100