API

Mendapatkan analitik promosi

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

Otorisasi

api-token + language + role

Parameter permintaan

date_creation_fromstring

Contoh: 25/04/2024

date_creation_tostring

Contoh: 26/04/2024

chain_idinteger
branch_idinteger
promo_codestring

Contoh: SALE20

typestring

Contoh: percent_discount_on_all_order

special_offer_idinteger

Contoh: 152410

platformstring (OrderPlatform)

Platform pemesanan

Nilai:androidapifbiosvksite

order_statusstring (OrderStatus)

Status pesanan: dalam perjalanan, selesai, dalam perakitan, di dapur, belum diproses, siap dikirim, menunggu dikirim ke dapur, menunggu perbaikan, dibatalkan, dikonfirmasi, sudah dimasak

Nilai:in_transitdoneassemblyin_kitchennot_processedready_to_transitwait_to_kitchenwait_remadecanceledconfirmedcooked

Contoh: confirmed

payment_statusstring (OrderPayment)

Status pembayaran: belum dibayar, menunggu, dibayar

Nilai:not_paidwaitingpaid

delivery_methodstring (OrderDelivery)

Metode pengiriman: kurir atau ambil sendiri

Nilai:courierpickup

Tanggapan

OK

object
statusstringwajib

Nilai:successerror

Contoh: success

dataobject
filtersobject
date_creation_fromobject (FilterDateFrom)
valuestringdapat bernilai null

Contoh: 2026-08-01 00:00:00

typestringwajib

Contoh: date

modestring (FilterMode)

Bagaimana antarmuka memproses filter; filter biasa tidak memiliki mode. force_shown — selalu ditampilkan, tidak bisa disembunyikan. value_required — titik masuk ke bagian: selalu ditampilkan, tidak memiliki nilai kosong (selama nilai belum dipilih, daftar kosong; tidak ada opsi "semua"), reset umum tidak menghapusnya.

Nilai:force_shownvalue_required

Contoh: value_required

date_creation_toobject (FilterDateTo)
valuestringdapat bernilai null

Contoh: 2026-08-31 23:59:59

typestringwajib

Contoh: date

modestring (FilterMode)

Bagaimana antarmuka memproses filter; filter biasa tidak memiliki mode. force_shown — selalu ditampilkan, tidak bisa disembunyikan. value_required — titik masuk ke bagian: selalu ditampilkan, tidak memiliki nilai kosong (selama nilai belum dipilih, daftar kosong; tidak ada opsi "semua"), reset umum tidak menghapusnya.

Nilai:force_shownvalue_required

Contoh: value_required

date_creation_rangeobject (FilterDateRange)

Periode filter tanggal yang sudah jadi; batas bawah dihitung berdasarkan zona waktu pengguna. value — periode yang sesuai dengan *_from dan *_to saat ini; null — periode kustom. default — periode yang akan diisi server dalam permintaan tanpa tanggal: juga digunakan saat pertama kali membuka bagian, dan saat reset kembali ke periode ini. Batas atas periode selalu sama dengan hari saat ini pengguna, sehingga option tidak menyertakannya: tidak perlu mengirimkan *_to untuk periode siap pakai, server akan menetapkannya secara otomatis. Periode yang lebih dari satu tahun akan dipotong dari sisi batas terbaru.

valuestring (DateRange) dapat bernilai null

Periode filter tanggal yang sudah siap. Tidak memiliki parameter permintaan sendiri: batas bawah sudah dihitung di option dan dimasukkan ke *_from. Batas atas tidak dikirimkan baik dalam respons maupun permintaan — selalu sama dengan hari ini menurut pengguna dan ditetapkan oleh server.

Nilai:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Contoh: today

defaultstring (DateRange) wajib

Periode filter tanggal yang sudah siap. Tidak memiliki parameter permintaan sendiri: batas bawah sudah dihitung di option dan dimasukkan ke *_from. Batas atas tidak dikirimkan baik dalam respons maupun permintaan — selalu sama dengan hari ini menurut pengguna dan ditetapkan oleh server.

Nilai:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Contoh: today

typestringwajib

Contoh: select

modestring (FilterMode)

Bagaimana antarmuka memproses filter; filter biasa tidak memiliki mode. force_shown — selalu ditampilkan, tidak bisa disembunyikan. value_required — titik masuk ke bagian: selalu ditampilkan, tidak memiliki nilai kosong (selama nilai belum dipilih, daftar kosong; tidak ada opsi "semua"), reset umum tidak menghapusnya.

Nilai:force_shownvalue_required

Contoh: value_required

optionarray of objectwajib
valuestring (DateRange) wajib

Periode filter tanggal yang sudah siap. Tidak memiliki parameter permintaan sendiri: batas bawah sudah dihitung di option dan dimasukkan ke *_from. Batas atas tidak dikirimkan baik dalam respons maupun permintaan — selalu sama dengan hari ini menurut pengguna dan ditetapkan oleh server.

Nilai:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Contoh: today

date_fromstringwajib

Contoh: 25/08/2026

chain_idobject (FilterSelectInteger)
valueinteger

Contoh: 8920

typestringwajib

Contoh: select

optionarray of object
valueintegerwajib

Contoh: 8920

namestringwajib

Contoh: Green Basket | Kaliningrad

modestring (FilterMode)

Bagaimana antarmuka memproses filter; filter biasa tidak memiliki mode. force_shown — selalu ditampilkan, tidak bisa disembunyikan. value_required — titik masuk ke bagian: selalu ditampilkan, tidak memiliki nilai kosong (selama nilai belum dipilih, daftar kosong; tidak ada opsi "semua"), reset umum tidak menghapusnya.

Nilai:force_shownvalue_required

Contoh: value_required

branch_idobject (FilterSelectInteger)
valueinteger

Contoh: 8920

typestringwajib

Contoh: select

optionarray of object
valueintegerwajib

Contoh: 8920

namestringwajib

Contoh: Green Basket | Kaliningrad

modestring (FilterMode)

Bagaimana antarmuka memproses filter; filter biasa tidak memiliki mode. force_shown — selalu ditampilkan, tidak bisa disembunyikan. value_required — titik masuk ke bagian: selalu ditampilkan, tidak memiliki nilai kosong (selama nilai belum dipilih, daftar kosong; tidak ada opsi "semua"), reset umum tidak menghapusnya.

Nilai:force_shownvalue_required

Contoh: value_required

promo_codeobject (FilterInput)
valuestring

Contoh: example

typestringwajib

Contoh: integer or string

placeholderstring

Contoh: string

modestring (FilterMode)

Bagaimana antarmuka memproses filter; filter biasa tidak memiliki mode. force_shown — selalu ditampilkan, tidak bisa disembunyikan. value_required — titik masuk ke bagian: selalu ditampilkan, tidak memiliki nilai kosong (selama nilai belum dipilih, daftar kosong; tidak ada opsi "semua"), reset umum tidak menghapusnya.

Nilai:force_shownvalue_required

Contoh: value_required

typeobject (FilterEnum)

Filter enum — daftar nilai enum datar

valuestring

Contoh: example

typestringwajib

Contoh: select

optionarray of string
modestring (FilterMode)

Bagaimana antarmuka memproses filter; filter biasa tidak memiliki mode. force_shown — selalu ditampilkan, tidak bisa disembunyikan. value_required — titik masuk ke bagian: selalu ditampilkan, tidak memiliki nilai kosong (selama nilai belum dipilih, daftar kosong; tidak ada opsi "semua"), reset umum tidak menghapusnya.

Nilai:force_shownvalue_required

Contoh: value_required

special_offer_idobject (FilterSelectInteger)
valueinteger

Contoh: 8920

typestringwajib

Contoh: select

optionarray of object
valueintegerwajib

Contoh: 8920

namestringwajib

Contoh: Green Basket | Kaliningrad

modestring (FilterMode)

Bagaimana antarmuka memproses filter; filter biasa tidak memiliki mode. force_shown — selalu ditampilkan, tidak bisa disembunyikan. value_required — titik masuk ke bagian: selalu ditampilkan, tidak memiliki nilai kosong (selama nilai belum dipilih, daftar kosong; tidak ada opsi "semua"), reset umum tidak menghapusnya.

Nilai:force_shownvalue_required

Contoh: value_required

platformobject (FilterEnum)

Filter enum — daftar nilai enum datar

valuestring

Contoh: example

typestringwajib

Contoh: select

optionarray of string
modestring (FilterMode)

Bagaimana antarmuka memproses filter; filter biasa tidak memiliki mode. force_shown — selalu ditampilkan, tidak bisa disembunyikan. value_required — titik masuk ke bagian: selalu ditampilkan, tidak memiliki nilai kosong (selama nilai belum dipilih, daftar kosong; tidak ada opsi "semua"), reset umum tidak menghapusnya.

Nilai:force_shownvalue_required

Contoh: value_required

order_statusobject (FilterEnum)

Filter enum — daftar nilai enum datar

valuestring

Contoh: example

typestringwajib

Contoh: select

optionarray of string
modestring (FilterMode)

Bagaimana antarmuka memproses filter; filter biasa tidak memiliki mode. force_shown — selalu ditampilkan, tidak bisa disembunyikan. value_required — titik masuk ke bagian: selalu ditampilkan, tidak memiliki nilai kosong (selama nilai belum dipilih, daftar kosong; tidak ada opsi "semua"), reset umum tidak menghapusnya.

Nilai:force_shownvalue_required

Contoh: value_required

payment_statusobject (FilterEnum)

Filter enum — daftar nilai enum datar

valuestring

Contoh: example

typestringwajib

Contoh: select

optionarray of string
modestring (FilterMode)

Bagaimana antarmuka memproses filter; filter biasa tidak memiliki mode. force_shown — selalu ditampilkan, tidak bisa disembunyikan. value_required — titik masuk ke bagian: selalu ditampilkan, tidak memiliki nilai kosong (selama nilai belum dipilih, daftar kosong; tidak ada opsi "semua"), reset umum tidak menghapusnya.

Nilai:force_shownvalue_required

Contoh: value_required

delivery_methodobject (FilterEnum)

Filter enum — daftar nilai enum datar

valuestring

Contoh: example

typestringwajib

Contoh: select

optionarray of string
modestring (FilterMode)

Bagaimana antarmuka memproses filter; filter biasa tidak memiliki mode. force_shown — selalu ditampilkan, tidak bisa disembunyikan. value_required — titik masuk ke bagian: selalu ditampilkan, tidak memiliki nilai kosong (selama nilai belum dipilih, daftar kosong; tidak ada opsi "semua"), reset umum tidak menghapusnya.

Nilai:force_shownvalue_required

Contoh: value_required

totalobject (SpecialOffersAnalyticsValues)
countintegerwajib

Contoh: 412

sumnumberwajib

Contoh: 531420.5

averagenumberwajib

Contoh: 1289.86

completed_countintegerwajib

Pesanan yang mencapai status done atau confirmed

Contoh: 379

completed_sharenumberwajib

Persentase pesanan yang selesai dalam setengah ini

Contoh: 91.99

share_of_countnumberwajib

Persentase dari semua pesanan dalam periode

Contoh: 34.2

share_of_sumnumberwajib

Contoh: 29.7

segmentsarray of object
keystringwajib

Apa arti setengah. Jika dipilih promo code, tipe promo, atau promo tertentu, setengah pertama dipersempit, dan pasangan menjadi matched_filter dan rest; penyebutnya dalam hal apa pun adalah semua pesanan dalam periode. Tentukan setengah berdasarkan key, bukan berdasarkan posisi.

Nilai:with_promo_codewithout_promo_codematched_filterrest

Contoh: with_promo_code

valuesobject (SpecialOffersAnalyticsValues) wajib
countintegerwajib

Contoh: 412

sumnumberwajib

Contoh: 531420.5

averagenumberwajib

Contoh: 1289.86

completed_countintegerwajib

Pesanan yang mencapai status done atau confirmed

Contoh: 379

completed_sharenumberwajib

Persentase pesanan yang selesai dalam setengah ini

Contoh: 91.99

share_of_countnumberwajib

Persentase dari semua pesanan dalam periode

Contoh: 34.2

share_of_sumnumberwajib

Contoh: 29.7

differenceobject

Setengah pertama dikurangi setengah kedua, dalam nilai absolut; proporsi dikurangkan dalam poin persentase

countinteger

Contoh: -284

sumnumber

Contoh: -412300.1

averagenumber

Contoh: 180.4

completed_sharenumber

Contoh: -3.11