API

Hangi pakkumiste analüütika saamine

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

Autoriseerimine

api-token + language + role

Päringu parameetrid

date_creation_fromstring

Näide: 25/04/2024

date_creation_tostring

Näide: 26/04/2024

chain_idinteger
branch_idinteger
promo_codestring

Näide: SALE20

typestring

Näide: percent_discount_on_all_order

special_offer_idinteger

Näide: 152410

platformstring (OrderPlatform)

Tellimuse platvorm

Väärtused:androidapifbiosvksite

order_statusstring (OrderStatus)

Tellimuse olek: teel, täidetud, komplekteerimisel, köögis, töötlemata, valmis saatmiseks, ootab kööki saatmist, ootab ümbertegemist, tühistatud, kinnitatud, valmistatud

Väärtused:in_transitdoneassemblyin_kitchennot_processedready_to_transitwait_to_kitchenwait_remadecanceledconfirmedcooked

Näide: confirmed

payment_statusstring (OrderPayment)

Makse staatus: maksmata, ootel, makstud

Väärtused:not_paidwaitingpaid

delivery_methodstring (OrderDelivery)

Tarneviis: kuller või ise järele tulemine

Väärtused:courierpickup

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

promo_codeobject (FilterInput)
valuestring

Näide: example

typestringkohustuslik

Näide: integer or string

placeholderstring

Näide: string

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

typeobject (FilterEnum)

Filtri enum — tasane loend enum väärtustest

valuestring

Näide: example

typestringkohustuslik

Näide: select

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

special_offer_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

platformobject (FilterEnum)

Filtri enum — tasane loend enum väärtustest

valuestring

Näide: example

typestringkohustuslik

Näide: select

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

order_statusobject (FilterEnum)

Filtri enum — tasane loend enum väärtustest

valuestring

Näide: example

typestringkohustuslik

Näide: select

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

payment_statusobject (FilterEnum)

Filtri enum — tasane loend enum väärtustest

valuestring

Näide: example

typestringkohustuslik

Näide: select

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

delivery_methodobject (FilterEnum)

Filtri enum — tasane loend enum väärtustest

valuestring

Näide: example

typestringkohustuslik

Näide: select

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

totalobject (SpecialOffersAnalyticsValues)
countintegerkohustuslik

Näide: 412

sumnumberkohustuslik

Näide: 531420.5

averagenumberkohustuslik

Näide: 1289.86

completed_countintegerkohustuslik

Tellimused, mis on jõudnud staatusteni done või confirmed

Näide: 379

completed_sharenumberkohustuslik

Lõpetatud tellimuste osakaal selles pooles, protsentides

Näide: 91.99

share_of_countnumberkohustuslik

Protsentuaalne osakaal kõigist perioodi tellimustest

Näide: 34.2

share_of_sumnumberkohustuslik

Näide: 29.7

segmentsarray of object
keystringkohustuslik

Mida tähendab pool. Kui on valitud promokood, kampaania tüüp või konkreetne kampaania, kitseneb esimene pool ning paariks saavad matched_filter ja rest; nimetaja on igal juhul perioodi kõik tellimused. Määrake pool vastavalt key, mitte positsiooni järgi.

Väärtused:with_promo_codewithout_promo_codematched_filterrest

Näide: with_promo_code

valuesobject (SpecialOffersAnalyticsValues) kohustuslik
countintegerkohustuslik

Näide: 412

sumnumberkohustuslik

Näide: 531420.5

averagenumberkohustuslik

Näide: 1289.86

completed_countintegerkohustuslik

Tellimused, mis on jõudnud staatusteni done või confirmed

Näide: 379

completed_sharenumberkohustuslik

Lõpetatud tellimuste osakaal selles pooles, protsentides

Näide: 91.99

share_of_countnumberkohustuslik

Protsentuaalne osakaal kõigist perioodi tellimustest

Näide: 34.2

share_of_sumnumberkohustuslik

Näide: 29.7

differenceobject

Esimene pool miinus teine, absoluutväärtustes; osad lahutatakse protsendipunktides

countinteger

Näide: -284

sumnumber

Näide: -412300.1

averagenumber

Näide: 180.4

completed_sharenumber

Näide: -3.11