API

Aksiyaların analitikasını əldə et

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

Avtorizasiya

api-token + language + role

Sorğu parametrləri

date_creation_fromstring

Nümunə: 25/04/2024

date_creation_tostring

Nümunə: 26/04/2024

chain_idinteger
branch_idinteger
promo_codestring

Nümunə: SALE20

typestring

Nümunə: percent_discount_on_all_order

special_offer_idinteger

Nümunə: 152410

platformstring (OrderPlatform)

Sifariş platforması

Dəyərlər:androidapifbiosvksite

order_statusstring (OrderStatus)

Sifariş statusu: yoldadır, tamamlandı, yığılır, mətbəxdədir, işlənməyib, göndərilməyə hazırdır, mətbəxə göndərilməyi gözləyir, yenidən hazırlanmanı gözləyir, ləğv edilib, təsdiqlənib, hazırlanıb

Dəyərlər:in_transitdoneassemblyin_kitchennot_processedready_to_transitwait_to_kitchenwait_remadecanceledconfirmedcooked

Nümunə: confirmed

payment_statusstring (OrderPayment)

Ödəniş statusu: ödənilməyib, gözləyir, ödənilib

Dəyərlər:not_paidwaitingpaid

delivery_methodstring (OrderDelivery)

Çatdırılma üsulu: kuryer və ya özün götürmə

Dəyərlər:courierpickup

Cavablar

OK

object
statusstringmütləq

Dəyərlər:successerror

Nümunə: success

dataobject
filtersobject
date_creation_fromobject (FilterDateFrom)
valuestringnull ola bilər

Nümunə: 2026-08-01 00:00:00

typestringmütləq

Nümunə: date

modestring (FilterMode)

İnterfeys filtrin işlənməsini belə idarə edir: adi filtrdə mode yoxdur. force_shown — həmişə göstərilir, gizlədilə bilməz. value_required — bölməyə giriş nöqtəsidir: həmişə göstərilir, boş dəyəri olmur (dəyər seçilməyənə qədər siyahı boşdur; "hamısı" seçimi yoxdur), ümumi sıfırlama onu təmizləmir.

Dəyərlər:force_shownvalue_required

Nümunə: value_required

date_creation_toobject (FilterDateTo)
valuestringnull ola bilər

Nümunə: 2026-08-31 23:59:59

typestringmütləq

Nümunə: date

modestring (FilterMode)

İnterfeys filtrin işlənməsini belə idarə edir: adi filtrdə mode yoxdur. force_shown — həmişə göstərilir, gizlədilə bilməz. value_required — bölməyə giriş nöqtəsidir: həmişə göstərilir, boş dəyəri olmur (dəyər seçilməyənə qədər siyahı boşdur; "hamısı" seçimi yoxdur), ümumi sıfırlama onu təmizləmir.

Dəyərlər:force_shownvalue_required

Nümunə: value_required

date_creation_rangeobject (FilterDateRange)

Hazır tarix aralığı filtrləri; aşağı sərhəd istifadəçinin saat qurşağında hesablanır. value — cari *_from və *_to-ya uyğun olan aralıq; null — istənilən aralıq. default — serverin tarixsiz sorğuda təyin etdiyi aralıq: həmçinin bölmə ilk dəfə yüklənəndə və sıfırlama zamanı tətbiq olunur. Aralığın yuxarı sərhədi həmişə istifadəçinin cari gününə bərabərdir, buna görə option onu ehtiva etmir: hazır aralıq üçün *_to göndərmək lazım deyil, server onu özü təyin edir. Bir ildən uzun aralıq yeni sərhəd tərəfindən kəsilir.

valuestring (DateRange) null ola bilər

Hazır tarix aralığı filtri. Bunun üçün ayrıca sorğu parametri yoxdur: aşağı sərhəd artıq hesablanmış şəkildə option daxilində gəlir və *_from sahəsinə əlavə olunur. Yuxarı sərhəd nə cavabda, nə də sorğuda ötürülmür — o, həmişə istifadəçinin cari gününə bərabərdir və server tərəfindən təyin olunur.

Dəyərlər:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Nümunə: today

defaultstring (DateRange) mütləq

Hazır tarix aralığı filtri. Bunun üçün ayrıca sorğu parametri yoxdur: aşağı sərhəd artıq hesablanmış şəkildə option daxilində gəlir və *_from sahəsinə əlavə olunur. Yuxarı sərhəd nə cavabda, nə də sorğuda ötürülmür — o, həmişə istifadəçinin cari gününə bərabərdir və server tərəfindən təyin olunur.

Dəyərlər:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Nümunə: today

typestringmütləq

Nümunə: select

modestring (FilterMode)

İnterfeys filtrin işlənməsini belə idarə edir: adi filtrdə mode yoxdur. force_shown — həmişə göstərilir, gizlədilə bilməz. value_required — bölməyə giriş nöqtəsidir: həmişə göstərilir, boş dəyəri olmur (dəyər seçilməyənə qədər siyahı boşdur; "hamısı" seçimi yoxdur), ümumi sıfırlama onu təmizləmir.

Dəyərlər:force_shownvalue_required

Nümunə: value_required

optionarray of objectmütləq
valuestring (DateRange) mütləq

Hazır tarix aralığı filtri. Bunun üçün ayrıca sorğu parametri yoxdur: aşağı sərhəd artıq hesablanmış şəkildə option daxilində gəlir və *_from sahəsinə əlavə olunur. Yuxarı sərhəd nə cavabda, nə də sorğuda ötürülmür — o, həmişə istifadəçinin cari gününə bərabərdir və server tərəfindən təyin olunur.

Dəyərlər:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Nümunə: today

date_fromstringmütləq

Nümunə: 25/08/2026

chain_idobject (FilterSelectInteger)
valueinteger

Nümunə: 8920

typestringmütləq

Nümunə: select

optionarray of object
valueintegermütləq

Nümunə: 8920

namestringmütləq

Nümunə: Green Basket | Kaliningrad

modestring (FilterMode)

İnterfeys filtrin işlənməsini belə idarə edir: adi filtrdə mode yoxdur. force_shown — həmişə göstərilir, gizlədilə bilməz. value_required — bölməyə giriş nöqtəsidir: həmişə göstərilir, boş dəyəri olmur (dəyər seçilməyənə qədər siyahı boşdur; "hamısı" seçimi yoxdur), ümumi sıfırlama onu təmizləmir.

Dəyərlər:force_shownvalue_required

Nümunə: value_required

branch_idobject (FilterSelectInteger)
valueinteger

Nümunə: 8920

typestringmütləq

Nümunə: select

optionarray of object
valueintegermütləq

Nümunə: 8920

namestringmütləq

Nümunə: Green Basket | Kaliningrad

modestring (FilterMode)

İnterfeys filtrin işlənməsini belə idarə edir: adi filtrdə mode yoxdur. force_shown — həmişə göstərilir, gizlədilə bilməz. value_required — bölməyə giriş nöqtəsidir: həmişə göstərilir, boş dəyəri olmur (dəyər seçilməyənə qədər siyahı boşdur; "hamısı" seçimi yoxdur), ümumi sıfırlama onu təmizləmir.

Dəyərlər:force_shownvalue_required

Nümunə: value_required

promo_codeobject (FilterInput)
valuestring

Nümunə: example

typestringmütləq

Nümunə: integer or string

placeholderstring

Nümunə: string

modestring (FilterMode)

İnterfeys filtrin işlənməsini belə idarə edir: adi filtrdə mode yoxdur. force_shown — həmişə göstərilir, gizlədilə bilməz. value_required — bölməyə giriş nöqtəsidir: həmişə göstərilir, boş dəyəri olmur (dəyər seçilməyənə qədər siyahı boşdur; "hamısı" seçimi yoxdur), ümumi sıfırlama onu təmizləmir.

Dəyərlər:force_shownvalue_required

Nümunə: value_required

typeobject (FilterEnum)

Filtr-siyahı — düz siyahı enum dəyərləri

valuestring

Nümunə: example

typestringmütləq

Nümunə: select

optionarray of string
modestring (FilterMode)

İnterfeys filtrin işlənməsini belə idarə edir: adi filtrdə mode yoxdur. force_shown — həmişə göstərilir, gizlədilə bilməz. value_required — bölməyə giriş nöqtəsidir: həmişə göstərilir, boş dəyəri olmur (dəyər seçilməyənə qədər siyahı boşdur; "hamısı" seçimi yoxdur), ümumi sıfırlama onu təmizləmir.

Dəyərlər:force_shownvalue_required

Nümunə: value_required

special_offer_idobject (FilterSelectInteger)
valueinteger

Nümunə: 8920

typestringmütləq

Nümunə: select

optionarray of object
valueintegermütləq

Nümunə: 8920

namestringmütləq

Nümunə: Green Basket | Kaliningrad

modestring (FilterMode)

İnterfeys filtrin işlənməsini belə idarə edir: adi filtrdə mode yoxdur. force_shown — həmişə göstərilir, gizlədilə bilməz. value_required — bölməyə giriş nöqtəsidir: həmişə göstərilir, boş dəyəri olmur (dəyər seçilməyənə qədər siyahı boşdur; "hamısı" seçimi yoxdur), ümumi sıfırlama onu təmizləmir.

Dəyərlər:force_shownvalue_required

Nümunə: value_required

platformobject (FilterEnum)

Filtr-siyahı — düz siyahı enum dəyərləri

valuestring

Nümunə: example

typestringmütləq

Nümunə: select

optionarray of string
modestring (FilterMode)

İnterfeys filtrin işlənməsini belə idarə edir: adi filtrdə mode yoxdur. force_shown — həmişə göstərilir, gizlədilə bilməz. value_required — bölməyə giriş nöqtəsidir: həmişə göstərilir, boş dəyəri olmur (dəyər seçilməyənə qədər siyahı boşdur; "hamısı" seçimi yoxdur), ümumi sıfırlama onu təmizləmir.

Dəyərlər:force_shownvalue_required

Nümunə: value_required

order_statusobject (FilterEnum)

Filtr-siyahı — düz siyahı enum dəyərləri

valuestring

Nümunə: example

typestringmütləq

Nümunə: select

optionarray of string
modestring (FilterMode)

İnterfeys filtrin işlənməsini belə idarə edir: adi filtrdə mode yoxdur. force_shown — həmişə göstərilir, gizlədilə bilməz. value_required — bölməyə giriş nöqtəsidir: həmişə göstərilir, boş dəyəri olmur (dəyər seçilməyənə qədər siyahı boşdur; "hamısı" seçimi yoxdur), ümumi sıfırlama onu təmizləmir.

Dəyərlər:force_shownvalue_required

Nümunə: value_required

payment_statusobject (FilterEnum)

Filtr-siyahı — düz siyahı enum dəyərləri

valuestring

Nümunə: example

typestringmütləq

Nümunə: select

optionarray of string
modestring (FilterMode)

İnterfeys filtrin işlənməsini belə idarə edir: adi filtrdə mode yoxdur. force_shown — həmişə göstərilir, gizlədilə bilməz. value_required — bölməyə giriş nöqtəsidir: həmişə göstərilir, boş dəyəri olmur (dəyər seçilməyənə qədər siyahı boşdur; "hamısı" seçimi yoxdur), ümumi sıfırlama onu təmizləmir.

Dəyərlər:force_shownvalue_required

Nümunə: value_required

delivery_methodobject (FilterEnum)

Filtr-siyahı — düz siyahı enum dəyərləri

valuestring

Nümunə: example

typestringmütləq

Nümunə: select

optionarray of string
modestring (FilterMode)

İnterfeys filtrin işlənməsini belə idarə edir: adi filtrdə mode yoxdur. force_shown — həmişə göstərilir, gizlədilə bilməz. value_required — bölməyə giriş nöqtəsidir: həmişə göstərilir, boş dəyəri olmur (dəyər seçilməyənə qədər siyahı boşdur; "hamısı" seçimi yoxdur), ümumi sıfırlama onu təmizləmir.

Dəyərlər:force_shownvalue_required

Nümunə: value_required

totalobject (SpecialOffersAnalyticsValues)
countintegermütləq

Nümunə: 412

sumnumbermütləq

Nümunə: 531420.5

averagenumbermütləq

Nümunə: 1289.86

completed_countintegermütləq

Sifari̇şlər, done və ya confirmed statusuna çatanlar

Nümunə: 379

completed_sharenumbermütləq

Bu yarıda tamamlanmış sifarişlərin payı, faizlə

Nümunə: 91.99

share_of_countnumbermütləq

Müddət ərzində bütün sifarişlərin faiz nisbəti

Nümunə: 34.2

share_of_sumnumbermütləq

Nümunə: 29.7

segmentsarray of object
keystringmütləq

Yarısı nə deməkdir. Əgər promokod, aksiya tipi və ya konkret aksiya seçilibsə, birinci yarı daralır və cütlük matched_filter və rest olur; məxrəc isə istənilən halda dövrün bütün sifarişləridir. Yarını key ilə müəyyən edin, mövqeyə görə yox.

Dəyərlər:with_promo_codewithout_promo_codematched_filterrest

Nümunə: with_promo_code

valuesobject (SpecialOffersAnalyticsValues) mütləq
countintegermütləq

Nümunə: 412

sumnumbermütləq

Nümunə: 531420.5

averagenumbermütləq

Nümunə: 1289.86

completed_countintegermütləq

Sifari̇şlər, done və ya confirmed statusuna çatanlar

Nümunə: 379

completed_sharenumbermütləq

Bu yarıda tamamlanmış sifarişlərin payı, faizlə

Nümunə: 91.99

share_of_countnumbermütləq

Müddət ərzində bütün sifarişlərin faiz nisbəti

Nümunə: 34.2

share_of_sumnumbermütləq

Nümunə: 29.7

differenceobject

Birinci yarıdan ikinci yarı çıxılır, mütləq qiymətlərlə; paylar faiz bəndləri ilə çıxılır

countinteger

Nümunə: -284

sumnumber

Nümunə: -412300.1

averagenumber

Nümunə: 180.4

completed_sharenumber

Nümunə: -3.11