API

Obțineți analiza promoțiilor

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

Autorizare

api-token + language + role

Parametri de interogare

date_creation_fromstring

Exemplu: 25/04/2024

date_creation_tostring

Exemplu: 26/04/2024

chain_idinteger
branch_idinteger
promo_codestring

Exemplu: SALE20

typestring

Exemplu: percent_discount_on_all_order

special_offer_idinteger

Exemplu: 152410

platformstring (OrderPlatform)

Platforma de comandă

Valori:androidapifbiosvksite

order_statusstring (OrderStatus)

Stare comandă: în drum, finalizat, în asamblare, la bucătărie, neprocesat, gata de expediere, așteaptă trimiterea la bucătărie, așteaptă refacere, anulat, confirmat, pregătit

Valori:in_transitdoneassemblyin_kitchennot_processedready_to_transitwait_to_kitchenwait_remadecanceledconfirmedcooked

Exemplu: confirmed

payment_statusstring (OrderPayment)

Stare plată: neplătit, în așteptare, plătit

Valori:not_paidwaitingpaid

delivery_methodstring (OrderDelivery)

Metoda de livrare: curier sau ridicare personală

Valori:courierpickup

Răspunsuri

OK

object
statusstringobligatoriu

Valori:successerror

Exemplu: success

dataobject
filtersobject
date_creation_fromobject (FilterDateFrom)
valuestringpoate fi null

Exemplu: 2026-08-01 00:00:00

typestringobligatoriu

Exemplu: date

modestring (FilterMode)

Cum interfața procesează filtrul; filtrul obișnuit nu are mode. force_shown — este întotdeauna afișat, nu poate fi ascuns. value_required — punct de intrare în secțiune: este întotdeauna afișat, nu poate avea valoare goală (până când nu este selectată o valoare, lista este goală; nu există opțiunea „toate”), resetarea generală nu îl curăță.

Valori:force_shownvalue_required

Exemplu: value_required

date_creation_toobject (FilterDateTo)
valuestringpoate fi null

Exemplu: 2026-08-31 23:59:59

typestringobligatoriu

Exemplu: date

modestring (FilterMode)

Cum interfața procesează filtrul; filtrul obișnuit nu are mode. force_shown — este întotdeauna afișat, nu poate fi ascuns. value_required — punct de intrare în secțiune: este întotdeauna afișat, nu poate avea valoare goală (până când nu este selectată o valoare, lista este goală; nu există opțiunea „toate”), resetarea generală nu îl curăță.

Valori:force_shownvalue_required

Exemplu: value_required

date_creation_rangeobject (FilterDateRange)

Perioade predefinite pentru filtrul de dată; limita inferioară este calculată în fusul orar al utilizatorului. value — perioada pentru care corespund valorile curente *_from și *_to; null — perioadă personalizată. default — perioada pe care serverul o setează în cererile fără date: aceasta se aplică la prima încărcare a secțiunii și la resetare. Limita superioară a perioadei este întotdeauna egală cu ziua curentă a utilizatorului, de aceea option nu o conține: nu este necesar să transmiteți *_to pentru o perioadă predefinită, serverul o setează automat. O perioadă mai lungă de un an este tăiată dinspre limita recentă.

valuestring (DateRange) poate fi null

Perioadă de filtrare predefinită după dată. Nu are propriul parametru de interogare: limita inferioară este deja calculată în option și este transmisă în *_from. Limita superioară nu este transmisă nici în răspuns, nici în cerere — este întotdeauna egală cu ziua curentă a utilizatorului și este setată de server.

Valori:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Exemplu: today

defaultstring (DateRange) obligatoriu

Perioadă de filtrare predefinită după dată. Nu are propriul parametru de interogare: limita inferioară este deja calculată în option și este transmisă în *_from. Limita superioară nu este transmisă nici în răspuns, nici în cerere — este întotdeauna egală cu ziua curentă a utilizatorului și este setată de server.

Valori:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Exemplu: today

typestringobligatoriu

Exemplu: select

modestring (FilterMode)

Cum interfața procesează filtrul; filtrul obișnuit nu are mode. force_shown — este întotdeauna afișat, nu poate fi ascuns. value_required — punct de intrare în secțiune: este întotdeauna afișat, nu poate avea valoare goală (până când nu este selectată o valoare, lista este goală; nu există opțiunea „toate”), resetarea generală nu îl curăță.

Valori:force_shownvalue_required

Exemplu: value_required

optionarray of objectobligatoriu
valuestring (DateRange) obligatoriu

Perioadă de filtrare predefinită după dată. Nu are propriul parametru de interogare: limita inferioară este deja calculată în option și este transmisă în *_from. Limita superioară nu este transmisă nici în răspuns, nici în cerere — este întotdeauna egală cu ziua curentă a utilizatorului și este setată de server.

Valori:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Exemplu: today

date_fromstringobligatoriu

Exemplu: 25/08/2026

chain_idobject (FilterSelectInteger)
valueinteger

Exemplu: 8920

typestringobligatoriu

Exemplu: select

optionarray of object
valueintegerobligatoriu

Exemplu: 8920

namestringobligatoriu

Exemplu: Green Basket | Kaliningrad

modestring (FilterMode)

Cum interfața procesează filtrul; filtrul obișnuit nu are mode. force_shown — este întotdeauna afișat, nu poate fi ascuns. value_required — punct de intrare în secțiune: este întotdeauna afișat, nu poate avea valoare goală (până când nu este selectată o valoare, lista este goală; nu există opțiunea „toate”), resetarea generală nu îl curăță.

Valori:force_shownvalue_required

Exemplu: value_required

branch_idobject (FilterSelectInteger)
valueinteger

Exemplu: 8920

typestringobligatoriu

Exemplu: select

optionarray of object
valueintegerobligatoriu

Exemplu: 8920

namestringobligatoriu

Exemplu: Green Basket | Kaliningrad

modestring (FilterMode)

Cum interfața procesează filtrul; filtrul obișnuit nu are mode. force_shown — este întotdeauna afișat, nu poate fi ascuns. value_required — punct de intrare în secțiune: este întotdeauna afișat, nu poate avea valoare goală (până când nu este selectată o valoare, lista este goală; nu există opțiunea „toate”), resetarea generală nu îl curăță.

Valori:force_shownvalue_required

Exemplu: value_required

promo_codeobject (FilterInput)
valuestring

Exemplu: example

typestringobligatoriu

Exemplu: integer or string

placeholderstring

Exemplu: string

modestring (FilterMode)

Cum interfața procesează filtrul; filtrul obișnuit nu are mode. force_shown — este întotdeauna afișat, nu poate fi ascuns. value_required — punct de intrare în secțiune: este întotdeauna afișat, nu poate avea valoare goală (până când nu este selectată o valoare, lista este goală; nu există opțiunea „toate”), resetarea generală nu îl curăță.

Valori:force_shownvalue_required

Exemplu: value_required

typeobject (FilterEnum)

Filtru-enumerație — listă plată de valori ale enumerației

valuestring

Exemplu: example

typestringobligatoriu

Exemplu: select

optionarray of string
modestring (FilterMode)

Cum interfața procesează filtrul; filtrul obișnuit nu are mode. force_shown — este întotdeauna afișat, nu poate fi ascuns. value_required — punct de intrare în secțiune: este întotdeauna afișat, nu poate avea valoare goală (până când nu este selectată o valoare, lista este goală; nu există opțiunea „toate”), resetarea generală nu îl curăță.

Valori:force_shownvalue_required

Exemplu: value_required

special_offer_idobject (FilterSelectInteger)
valueinteger

Exemplu: 8920

typestringobligatoriu

Exemplu: select

optionarray of object
valueintegerobligatoriu

Exemplu: 8920

namestringobligatoriu

Exemplu: Green Basket | Kaliningrad

modestring (FilterMode)

Cum interfața procesează filtrul; filtrul obișnuit nu are mode. force_shown — este întotdeauna afișat, nu poate fi ascuns. value_required — punct de intrare în secțiune: este întotdeauna afișat, nu poate avea valoare goală (până când nu este selectată o valoare, lista este goală; nu există opțiunea „toate”), resetarea generală nu îl curăță.

Valori:force_shownvalue_required

Exemplu: value_required

platformobject (FilterEnum)

Filtru-enumerație — listă plată de valori ale enumerației

valuestring

Exemplu: example

typestringobligatoriu

Exemplu: select

optionarray of string
modestring (FilterMode)

Cum interfața procesează filtrul; filtrul obișnuit nu are mode. force_shown — este întotdeauna afișat, nu poate fi ascuns. value_required — punct de intrare în secțiune: este întotdeauna afișat, nu poate avea valoare goală (până când nu este selectată o valoare, lista este goală; nu există opțiunea „toate”), resetarea generală nu îl curăță.

Valori:force_shownvalue_required

Exemplu: value_required

order_statusobject (FilterEnum)

Filtru-enumerație — listă plată de valori ale enumerației

valuestring

Exemplu: example

typestringobligatoriu

Exemplu: select

optionarray of string
modestring (FilterMode)

Cum interfața procesează filtrul; filtrul obișnuit nu are mode. force_shown — este întotdeauna afișat, nu poate fi ascuns. value_required — punct de intrare în secțiune: este întotdeauna afișat, nu poate avea valoare goală (până când nu este selectată o valoare, lista este goală; nu există opțiunea „toate”), resetarea generală nu îl curăță.

Valori:force_shownvalue_required

Exemplu: value_required

payment_statusobject (FilterEnum)

Filtru-enumerație — listă plată de valori ale enumerației

valuestring

Exemplu: example

typestringobligatoriu

Exemplu: select

optionarray of string
modestring (FilterMode)

Cum interfața procesează filtrul; filtrul obișnuit nu are mode. force_shown — este întotdeauna afișat, nu poate fi ascuns. value_required — punct de intrare în secțiune: este întotdeauna afișat, nu poate avea valoare goală (până când nu este selectată o valoare, lista este goală; nu există opțiunea „toate”), resetarea generală nu îl curăță.

Valori:force_shownvalue_required

Exemplu: value_required

delivery_methodobject (FilterEnum)

Filtru-enumerație — listă plată de valori ale enumerației

valuestring

Exemplu: example

typestringobligatoriu

Exemplu: select

optionarray of string
modestring (FilterMode)

Cum interfața procesează filtrul; filtrul obișnuit nu are mode. force_shown — este întotdeauna afișat, nu poate fi ascuns. value_required — punct de intrare în secțiune: este întotdeauna afișat, nu poate avea valoare goală (până când nu este selectată o valoare, lista este goală; nu există opțiunea „toate”), resetarea generală nu îl curăță.

Valori:force_shownvalue_required

Exemplu: value_required

totalobject (SpecialOffersAnalyticsValues)
countintegerobligatoriu

Exemplu: 412

sumnumberobligatoriu

Exemplu: 531420.5

averagenumberobligatoriu

Exemplu: 1289.86

completed_countintegerobligatoriu

Comenzi care au ajuns la statusul done sau confirmed

Exemplu: 379

completed_sharenumberobligatoriu

Procentajul comenzilor finalizate în această jumătate

Exemplu: 91.99

share_of_countnumberobligatoriu

Procentaj din toate comenzile din perioadă

Exemplu: 34.2

share_of_sumnumberobligatoriu

Exemplu: 29.7

segmentsarray of object
keystringobligatoriu

Ce înseamnă jumătate. Dacă este selectat un cod promoțional, un tip de promoție sau o promoție specifică, prima jumătate se restrânge, iar perechea devine matched_filter și rest; numitorul este oricum toate comenzile din perioadă. Determinați jumătatea după key, nu după poziție.

Valori:with_promo_codewithout_promo_codematched_filterrest

Exemplu: with_promo_code

valuesobject (SpecialOffersAnalyticsValues) obligatoriu
countintegerobligatoriu

Exemplu: 412

sumnumberobligatoriu

Exemplu: 531420.5

averagenumberobligatoriu

Exemplu: 1289.86

completed_countintegerobligatoriu

Comenzi care au ajuns la statusul done sau confirmed

Exemplu: 379

completed_sharenumberobligatoriu

Procentajul comenzilor finalizate în această jumătate

Exemplu: 91.99

share_of_countnumberobligatoriu

Procentaj din toate comenzile din perioadă

Exemplu: 34.2

share_of_sumnumberobligatoriu

Exemplu: 29.7

differenceobject

Prima valoare minus a doua, în valori absolute; cotele sunt scăzute în puncte procentuale

countinteger

Exemplu: -284

sumnumber

Exemplu: -412300.1

averagenumber

Exemplu: 180.4

completed_sharenumber

Exemplu: -3.11