API

Iegūt akciju analītiku

GET/api/crm/v2/special_offers_analyticsv2
operationId: specialOffersAnalytics.default

Autorizācija

api-token + language + role

Vaicājuma parametri

date_creation_fromstring

Piemērs: 25/04/2024

date_creation_tostring

Piemērs: 26/04/2024

chain_idinteger
branch_idinteger
promo_codestring

Piemērs: SALE20

typestring

Piemērs: percent_discount_on_all_order

special_offer_idinteger

Piemērs: 152410

platformstring (OrderPlatform)

Pasūtījumu platforma

Vērtības:androidapifbiosvksite

order_statusstring (OrderStatus)

Pasūtījuma statuss: ceļā, izpildīts, komplektēšana, virtuvē, neapstrādāts, gatavs nosūtīšanai, gaida nosūtīšanu uz virtuvi, gaida pārstrādi, atcelts, apstiprināts, pagatavots

Vērtības:in_transitdoneassemblyin_kitchennot_processedready_to_transitwait_to_kitchenwait_remadecanceledconfirmedcooked

Piemērs: confirmed

payment_statusstring (OrderPayment)

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

Vērtības:not_paidwaitingpaid

delivery_methodstring (OrderDelivery)

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

Vērtības:courierpickup

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

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

promo_codeobject (FilterInput)
valuestring

Piemērs: example

typestringobligāts

Piemērs: integer or string

placeholderstring

Piemērs: 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

typeobject (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

special_offer_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

platformobject (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

order_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

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

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

totalobject (SpecialOffersAnalyticsValues)
countintegerobligāts

Piemērs: 412

sumnumberobligāts

Piemērs: 531420.5

averagenumberobligāts

Piemērs: 1289.86

completed_countintegerobligāts

Pasūtījumi, kas sasnieguši statusu done vai confirmed

Piemērs: 379

completed_sharenumberobligāts

Pabeigto pasūtījumu īpatsvars šajā pusē, procentos

Piemērs: 91.99

share_of_countnumberobligāts

Daļa no visiem perioda pasūtījumiem, procentos

Piemērs: 34.2

share_of_sumnumberobligāts

Piemērs: 29.7

segmentsarray of object
keystringobligāts

Ko nozīmē puse. Ja ir izvēlēts promokods, akcijas tips vai konkrēta akcija, pirmā puse tiek sašaurināta, un pāris kļūst par matched_filter un rest; saucējs jebkurā gadījumā ir visi perioda pasūtījumi. Pusi nosakiet pēc key, nevis pēc pozīcijas.

Vērtības:with_promo_codewithout_promo_codematched_filterrest

Piemērs: with_promo_code

valuesobject (SpecialOffersAnalyticsValues) obligāts
countintegerobligāts

Piemērs: 412

sumnumberobligāts

Piemērs: 531420.5

averagenumberobligāts

Piemērs: 1289.86

completed_countintegerobligāts

Pasūtījumi, kas sasnieguši statusu done vai confirmed

Piemērs: 379

completed_sharenumberobligāts

Pabeigto pasūtījumu īpatsvars šajā pusē, procentos

Piemērs: 91.99

share_of_countnumberobligāts

Daļa no visiem perioda pasūtījumiem, procentos

Piemērs: 34.2

share_of_sumnumberobligāts

Piemērs: 29.7

differenceobject

Pirmā puse mīnus otrā, absolūtās vērtībās; daļas tiek atņemtas procentpunktos

countinteger

Piemērs: -284

sumnumber

Piemērs: -412300.1

averagenumber

Piemērs: 180.4

completed_sharenumber

Piemērs: -3.11