API

Promosyon analizini al

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

Yetkilendirme

api-token + language + role

Sorgu parametreleri

date_creation_fromstring

Örnek: 25/04/2024

date_creation_tostring

Örnek: 26/04/2024

chain_idinteger
branch_idinteger
promo_codestring

Örnek: SALE20

typestring

Örnek: percent_discount_on_all_order

special_offer_idinteger

Örnek: 152410

platformstring (OrderPlatform)

Sipariş platformu

Değerler:androidapifbiosvksite

order_statusstring (OrderStatus)

Sipariş durumu: yolda, tamamlandı, hazırlanıyor, mutfakta, işlenmedi, gönderime hazır, mutfağa gönderilmeyi bekliyor, yeniden yapılmayı bekliyor, iptal edildi, onaylandı, hazırlandı

Değerler:in_transitdoneassemblyin_kitchennot_processedready_to_transitwait_to_kitchenwait_remadecanceledconfirmedcooked

Örnek: confirmed

payment_statusstring (OrderPayment)

Ödeme durumu: ödenmedi, beklemede, ödendi

Değerler:not_paidwaitingpaid

delivery_methodstring (OrderDelivery)

Teslimat yöntemi: kurye veya self-servis

Değerler:courierpickup

Yanıtlar

OK

object
statusstringzorunlu

Değerler:successerror

Örnek: success

dataobject
filtersobject
date_creation_fromobject (FilterDateFrom)
valuestringnull olabilir

Örnek: 2026-08-01 00:00:00

typestringzorunlu

Örnek: date

modestring (FilterMode)

Arayüzün filtreyi nasıl işlediği; standart bir filtrede mode yoktur. force_shown — her zaman gösterilir, gizlenemez. value_required — bölüme giriş noktasıdır: her zaman gösterilir, boş değeri yoktur (değer seçilene kadar liste boştur; "tümü" seçeneği yoktur), genel sıfırlama bunu temizlemez.

Değerler:force_shownvalue_required

Örnek: value_required

date_creation_toobject (FilterDateTo)
valuestringnull olabilir

Örnek: 2026-08-31 23:59:59

typestringzorunlu

Örnek: date

modestring (FilterMode)

Arayüzün filtreyi nasıl işlediği; standart bir filtrede mode yoktur. force_shown — her zaman gösterilir, gizlenemez. value_required — bölüme giriş noktasıdır: her zaman gösterilir, boş değeri yoktur (değer seçilene kadar liste boştur; "tümü" seçeneği yoktur), genel sıfırlama bunu temizlemez.

Değerler:force_shownvalue_required

Örnek: value_required

date_creation_rangeobject (FilterDateRange)

Hazır tarih filtre dönemleri; alt sınır, kullanıcının saat diliminde hesaplanır. value — mevcut *_from ve *_to ile eşleşen dönem; null — özel dönem. default — sunucunun tarih belirtilmeyen istekte kullandığı dönemdir: ayrıca bölüm ilk yüklendiğinde ve sıfırlama yapıldığında da uygulanır. Dönemin üst sınırı her zaman kullanıcının bugünkü tarihine eşittir, bu nedenle option bunu içermez: hazır dönem için *_to göndermeye gerek yoktur, sunucu bunu otomatik olarak ayarlar. Bir yıldan uzun dönemler, yeni tarihe yakın taraftan kesilir.

valuestring (DateRange) null olabilir

Hazır tarih aralığı filtresi. Bunun için ayrı bir sorgu parametresi yoktur: alt sınır, önceden hesaplanmış olarak option içinde gelir ve *_from alanına eklenir. Üst sınır ise ne yanıtta ne de istekte iletilir — her zaman kullanıcının bugünkü tarihiyle aynıdır ve sunucu tarafından belirlenir.

Değerler:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Örnek: today

defaultstring (DateRange) zorunlu

Hazır tarih aralığı filtresi. Bunun için ayrı bir sorgu parametresi yoktur: alt sınır, önceden hesaplanmış olarak option içinde gelir ve *_from alanına eklenir. Üst sınır ise ne yanıtta ne de istekte iletilir — her zaman kullanıcının bugünkü tarihiyle aynıdır ve sunucu tarafından belirlenir.

Değerler:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Örnek: today

typestringzorunlu

Örnek: select

modestring (FilterMode)

Arayüzün filtreyi nasıl işlediği; standart bir filtrede mode yoktur. force_shown — her zaman gösterilir, gizlenemez. value_required — bölüme giriş noktasıdır: her zaman gösterilir, boş değeri yoktur (değer seçilene kadar liste boştur; "tümü" seçeneği yoktur), genel sıfırlama bunu temizlemez.

Değerler:force_shownvalue_required

Örnek: value_required

optionarray of objectzorunlu
valuestring (DateRange) zorunlu

Hazır tarih aralığı filtresi. Bunun için ayrı bir sorgu parametresi yoktur: alt sınır, önceden hesaplanmış olarak option içinde gelir ve *_from alanına eklenir. Üst sınır ise ne yanıtta ne de istekte iletilir — her zaman kullanıcının bugünkü tarihiyle aynıdır ve sunucu tarafından belirlenir.

Değerler:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Örnek: today

date_fromstringzorunlu

Örnek: 25/08/2026

chain_idobject (FilterSelectInteger)
valueinteger

Örnek: 8920

typestringzorunlu

Örnek: select

optionarray of object
valueintegerzorunlu

Örnek: 8920

namestringzorunlu

Örnek: Green Basket | Kaliningrad

modestring (FilterMode)

Arayüzün filtreyi nasıl işlediği; standart bir filtrede mode yoktur. force_shown — her zaman gösterilir, gizlenemez. value_required — bölüme giriş noktasıdır: her zaman gösterilir, boş değeri yoktur (değer seçilene kadar liste boştur; "tümü" seçeneği yoktur), genel sıfırlama bunu temizlemez.

Değerler:force_shownvalue_required

Örnek: value_required

branch_idobject (FilterSelectInteger)
valueinteger

Örnek: 8920

typestringzorunlu

Örnek: select

optionarray of object
valueintegerzorunlu

Örnek: 8920

namestringzorunlu

Örnek: Green Basket | Kaliningrad

modestring (FilterMode)

Arayüzün filtreyi nasıl işlediği; standart bir filtrede mode yoktur. force_shown — her zaman gösterilir, gizlenemez. value_required — bölüme giriş noktasıdır: her zaman gösterilir, boş değeri yoktur (değer seçilene kadar liste boştur; "tümü" seçeneği yoktur), genel sıfırlama bunu temizlemez.

Değerler:force_shownvalue_required

Örnek: value_required

promo_codeobject (FilterInput)
valuestring

Örnek: example

typestringzorunlu

Örnek: integer or string

placeholderstring

Örnek: string

modestring (FilterMode)

Arayüzün filtreyi nasıl işlediği; standart bir filtrede mode yoktur. force_shown — her zaman gösterilir, gizlenemez. value_required — bölüme giriş noktasıdır: her zaman gösterilir, boş değeri yoktur (değer seçilene kadar liste boştur; "tümü" seçeneği yoktur), genel sıfırlama bunu temizlemez.

Değerler:force_shownvalue_required

Örnek: value_required

typeobject (FilterEnum)

Filtre-enum — düz enum değerleri listesi

valuestring

Örnek: example

typestringzorunlu

Örnek: select

optionarray of string
modestring (FilterMode)

Arayüzün filtreyi nasıl işlediği; standart bir filtrede mode yoktur. force_shown — her zaman gösterilir, gizlenemez. value_required — bölüme giriş noktasıdır: her zaman gösterilir, boş değeri yoktur (değer seçilene kadar liste boştur; "tümü" seçeneği yoktur), genel sıfırlama bunu temizlemez.

Değerler:force_shownvalue_required

Örnek: value_required

special_offer_idobject (FilterSelectInteger)
valueinteger

Örnek: 8920

typestringzorunlu

Örnek: select

optionarray of object
valueintegerzorunlu

Örnek: 8920

namestringzorunlu

Örnek: Green Basket | Kaliningrad

modestring (FilterMode)

Arayüzün filtreyi nasıl işlediği; standart bir filtrede mode yoktur. force_shown — her zaman gösterilir, gizlenemez. value_required — bölüme giriş noktasıdır: her zaman gösterilir, boş değeri yoktur (değer seçilene kadar liste boştur; "tümü" seçeneği yoktur), genel sıfırlama bunu temizlemez.

Değerler:force_shownvalue_required

Örnek: value_required

platformobject (FilterEnum)

Filtre-enum — düz enum değerleri listesi

valuestring

Örnek: example

typestringzorunlu

Örnek: select

optionarray of string
modestring (FilterMode)

Arayüzün filtreyi nasıl işlediği; standart bir filtrede mode yoktur. force_shown — her zaman gösterilir, gizlenemez. value_required — bölüme giriş noktasıdır: her zaman gösterilir, boş değeri yoktur (değer seçilene kadar liste boştur; "tümü" seçeneği yoktur), genel sıfırlama bunu temizlemez.

Değerler:force_shownvalue_required

Örnek: value_required

order_statusobject (FilterEnum)

Filtre-enum — düz enum değerleri listesi

valuestring

Örnek: example

typestringzorunlu

Örnek: select

optionarray of string
modestring (FilterMode)

Arayüzün filtreyi nasıl işlediği; standart bir filtrede mode yoktur. force_shown — her zaman gösterilir, gizlenemez. value_required — bölüme giriş noktasıdır: her zaman gösterilir, boş değeri yoktur (değer seçilene kadar liste boştur; "tümü" seçeneği yoktur), genel sıfırlama bunu temizlemez.

Değerler:force_shownvalue_required

Örnek: value_required

payment_statusobject (FilterEnum)

Filtre-enum — düz enum değerleri listesi

valuestring

Örnek: example

typestringzorunlu

Örnek: select

optionarray of string
modestring (FilterMode)

Arayüzün filtreyi nasıl işlediği; standart bir filtrede mode yoktur. force_shown — her zaman gösterilir, gizlenemez. value_required — bölüme giriş noktasıdır: her zaman gösterilir, boş değeri yoktur (değer seçilene kadar liste boştur; "tümü" seçeneği yoktur), genel sıfırlama bunu temizlemez.

Değerler:force_shownvalue_required

Örnek: value_required

delivery_methodobject (FilterEnum)

Filtre-enum — düz enum değerleri listesi

valuestring

Örnek: example

typestringzorunlu

Örnek: select

optionarray of string
modestring (FilterMode)

Arayüzün filtreyi nasıl işlediği; standart bir filtrede mode yoktur. force_shown — her zaman gösterilir, gizlenemez. value_required — bölüme giriş noktasıdır: her zaman gösterilir, boş değeri yoktur (değer seçilene kadar liste boştur; "tümü" seçeneği yoktur), genel sıfırlama bunu temizlemez.

Değerler:force_shownvalue_required

Örnek: value_required

totalobject (SpecialOffersAnalyticsValues)
countintegerzorunlu

Örnek: 412

sumnumberzorunlu

Örnek: 531420.5

averagenumberzorunlu

Örnek: 1289.86

completed_countintegerzorunlu

done veya confirmed durumuna ulaşan siparişler

Örnek: 379

completed_sharenumberzorunlu

Bu yarıdaki tamamlanan siparişlerin oranı, yüzde olarak

Örnek: 91.99

share_of_countnumberzorunlu

Dönem içindeki tüm siparişlerin yüzdesi

Örnek: 34.2

share_of_sumnumberzorunlu

Örnek: 29.7

segmentsarray of object
keystringzorunlu

Ne anlama gelir yarısı. Eğer bir promosyon kodu, kampanya türü veya belirli bir kampanya seçildiyse, ilk yarı daralır ve çift matched_filter ile rest olur; payda her durumda dönemin tüm siparişleridir. Yarısını key ile belirleyin, pozisyona göre değil.

Değerler:with_promo_codewithout_promo_codematched_filterrest

Örnek: with_promo_code

valuesobject (SpecialOffersAnalyticsValues) zorunlu
countintegerzorunlu

Örnek: 412

sumnumberzorunlu

Örnek: 531420.5

averagenumberzorunlu

Örnek: 1289.86

completed_countintegerzorunlu

done veya confirmed durumuna ulaşan siparişler

Örnek: 379

completed_sharenumberzorunlu

Bu yarıdaki tamamlanan siparişlerin oranı, yüzde olarak

Örnek: 91.99

share_of_countnumberzorunlu

Dönem içindeki tüm siparişlerin yüzdesi

Örnek: 34.2

share_of_sumnumberzorunlu

Örnek: 29.7

differenceobject

İlk yarıdan ikinci yarı çıkarılır, mutlak değer olarak; oranlar yüzde puan olarak çıkarılır

countinteger

Örnek: -284

sumnumber

Örnek: -412300.1

averagenumber

Örnek: 180.4

completed_sharenumber

Örnek: -3.11