API

Λήψη ανάλυσης προσφορών

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

Εξουσιοδότηση

api-token + language + role

Παράμετροι ερωτήματος

date_creation_fromstring

Παράδειγμα: 25/04/2024

date_creation_tostring

Παράδειγμα: 26/04/2024

chain_idinteger
branch_idinteger
promo_codestring

Παράδειγμα: SALE20

typestring

Παράδειγμα: percent_discount_on_all_order

special_offer_idinteger

Παράδειγμα: 152410

platformstring (OrderPlatform)

Πλατφόρμα παραγγελίας

Τιμές:androidapifbiosvksite

order_statusstring (OrderStatus)

Κατάσταση παραγγελίας: σε διαδρομή, ολοκληρώθηκε, σε συναρμολόγηση, στην κουζίνα, μη επεξεργασμένη, έτοιμη για αποστολή, αναμένει αποστολή στην κουζίνα, αναμένει επανεκτέλεση, ακυρώθηκε, επιβεβαιώθηκε, παρασκευάστηκε

Τιμές:in_transitdoneassemblyin_kitchennot_processedready_to_transitwait_to_kitchenwait_remadecanceledconfirmedcooked

Παράδειγμα: confirmed

payment_statusstring (OrderPayment)

Κατάσταση πληρωμής: δεν έχει πληρωθεί, σε αναμονή, πληρωμένο

Τιμές:not_paidwaitingpaid

delivery_methodstring (OrderDelivery)

Τρόπος παράδοσης: courier ή παραλαβή

Τιμές:courierpickup

Απαντήσεις

OK

object
statusstringυποχρεωτικό

Τιμές:successerror

Παράδειγμα: success

dataobject
filtersobject
date_creation_fromobject (FilterDateFrom)
valuestringμπορεί να είναι null

Παράδειγμα: 2026-08-01 00:00:00

typestringυποχρεωτικό

Παράδειγμα: date

modestring (FilterMode)

Πώς το περιβάλλον χειρίζεται το φίλτρο· το συνηθισμένο φίλτρο δεν έχει mode. Το force_shown — εμφανίζεται πάντα, δεν μπορεί να αποκρυφθεί. Το value_required — σημείο εισόδου στην ενότητα: εμφανίζεται πάντα, δεν έχει κενή τιμή (μέχρι να επιλεγεί τιμή, η λίστα είναι κενή· δεν υπάρχει επιλογή «όλα»), η γενική επαναφορά δεν το καθαρίζει.

Τιμές:force_shownvalue_required

Παράδειγμα: value_required

date_creation_toobject (FilterDateTo)
valuestringμπορεί να είναι null

Παράδειγμα: 2026-08-31 23:59:59

typestringυποχρεωτικό

Παράδειγμα: date

modestring (FilterMode)

Πώς το περιβάλλον χειρίζεται το φίλτρο· το συνηθισμένο φίλτρο δεν έχει mode. Το force_shown — εμφανίζεται πάντα, δεν μπορεί να αποκρυφθεί. Το value_required — σημείο εισόδου στην ενότητα: εμφανίζεται πάντα, δεν έχει κενή τιμή (μέχρι να επιλεγεί τιμή, η λίστα είναι κενή· δεν υπάρχει επιλογή «όλα»), η γενική επαναφορά δεν το καθαρίζει.

Τιμές:force_shownvalue_required

Παράδειγμα: value_required

date_creation_rangeobject (FilterDateRange)

Έτοιμες περίοδοι φίλτρου κατά ημερομηνία· το κάτω όριο υπολογίζεται στη ζώνη ώρας του χρήστη. Το value είναι η περίοδος που αντιστοιχεί στα τρέχοντα *_from και *_to· το null σημαίνει προσαρμοσμένη περίοδο. Το default είναι η περίοδος που ο διακομιστής ορίζει στο αίτημα χωρίς ημερομηνίες: εφαρμόζεται επίσης κατά την πρώτη φόρτωση της ενότητας και όταν γίνεται επαναφορά. Το ανώτερο όριο της περιόδου είναι πάντα η τρέχουσα ημέρα του χρήστη, επομένως το option δεν το περιέχει: δεν χρειάζεται να αποστείλετε *_to για έτοιμη περίοδο, ο διακομιστής το ορίζει αυτόματα. Περίοδος μεγαλύτερη από ένα έτος περικόπτεται από την πιο πρόσφατη πλευρά.

valuestring (DateRange) μπορεί να είναι null

Έτοιμη περίοδος φίλτρου κατά ημερομηνία. Δεν διαθέτει δική της παράμετρο αιτήματος: το κάτω όριο υπολογίζεται εκ των προτέρων στο option και τοποθετείται στο *_from. Το άνω όριο δεν μεταδίδεται ούτε στην απάντηση ούτε στο αίτημα — είναι πάντα ίσο με την τρέχουσα ημέρα του χρήστη και ορίζεται από τον διακομιστή.

Τιμές:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Παράδειγμα: today

defaultstring (DateRange) υποχρεωτικό

Έτοιμη περίοδος φίλτρου κατά ημερομηνία. Δεν διαθέτει δική της παράμετρο αιτήματος: το κάτω όριο υπολογίζεται εκ των προτέρων στο option και τοποθετείται στο *_from. Το άνω όριο δεν μεταδίδεται ούτε στην απάντηση ούτε στο αίτημα — είναι πάντα ίσο με την τρέχουσα ημέρα του χρήστη και ορίζεται από τον διακομιστή.

Τιμές:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Παράδειγμα: today

typestringυποχρεωτικό

Παράδειγμα: select

modestring (FilterMode)

Πώς το περιβάλλον χειρίζεται το φίλτρο· το συνηθισμένο φίλτρο δεν έχει mode. Το force_shown — εμφανίζεται πάντα, δεν μπορεί να αποκρυφθεί. Το value_required — σημείο εισόδου στην ενότητα: εμφανίζεται πάντα, δεν έχει κενή τιμή (μέχρι να επιλεγεί τιμή, η λίστα είναι κενή· δεν υπάρχει επιλογή «όλα»), η γενική επαναφορά δεν το καθαρίζει.

Τιμές:force_shownvalue_required

Παράδειγμα: value_required

optionarray of objectυποχρεωτικό
valuestring (DateRange) υποχρεωτικό

Έτοιμη περίοδος φίλτρου κατά ημερομηνία. Δεν διαθέτει δική της παράμετρο αιτήματος: το κάτω όριο υπολογίζεται εκ των προτέρων στο option και τοποθετείται στο *_from. Το άνω όριο δεν μεταδίδεται ούτε στην απάντηση ούτε στο αίτημα — είναι πάντα ίσο με την τρέχουσα ημέρα του χρήστη και ορίζεται από τον διακομιστή.

Τιμές:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Παράδειγμα: today

date_fromstringυποχρεωτικό

Παράδειγμα: 25/08/2026

chain_idobject (FilterSelectInteger)
valueinteger

Παράδειγμα: 8920

typestringυποχρεωτικό

Παράδειγμα: select

optionarray of object
valueintegerυποχρεωτικό

Παράδειγμα: 8920

namestringυποχρεωτικό

Παράδειγμα: Green Basket | Kaliningrad

modestring (FilterMode)

Πώς το περιβάλλον χειρίζεται το φίλτρο· το συνηθισμένο φίλτρο δεν έχει mode. Το force_shown — εμφανίζεται πάντα, δεν μπορεί να αποκρυφθεί. Το value_required — σημείο εισόδου στην ενότητα: εμφανίζεται πάντα, δεν έχει κενή τιμή (μέχρι να επιλεγεί τιμή, η λίστα είναι κενή· δεν υπάρχει επιλογή «όλα»), η γενική επαναφορά δεν το καθαρίζει.

Τιμές:force_shownvalue_required

Παράδειγμα: value_required

branch_idobject (FilterSelectInteger)
valueinteger

Παράδειγμα: 8920

typestringυποχρεωτικό

Παράδειγμα: select

optionarray of object
valueintegerυποχρεωτικό

Παράδειγμα: 8920

namestringυποχρεωτικό

Παράδειγμα: Green Basket | Kaliningrad

modestring (FilterMode)

Πώς το περιβάλλον χειρίζεται το φίλτρο· το συνηθισμένο φίλτρο δεν έχει mode. Το force_shown — εμφανίζεται πάντα, δεν μπορεί να αποκρυφθεί. Το value_required — σημείο εισόδου στην ενότητα: εμφανίζεται πάντα, δεν έχει κενή τιμή (μέχρι να επιλεγεί τιμή, η λίστα είναι κενή· δεν υπάρχει επιλογή «όλα»), η γενική επαναφορά δεν το καθαρίζει.

Τιμές:force_shownvalue_required

Παράδειγμα: value_required

promo_codeobject (FilterInput)
valuestring

Παράδειγμα: example

typestringυποχρεωτικό

Παράδειγμα: integer or string

placeholderstring

Παράδειγμα: string

modestring (FilterMode)

Πώς το περιβάλλον χειρίζεται το φίλτρο· το συνηθισμένο φίλτρο δεν έχει mode. Το force_shown — εμφανίζεται πάντα, δεν μπορεί να αποκρυφθεί. Το value_required — σημείο εισόδου στην ενότητα: εμφανίζεται πάντα, δεν έχει κενή τιμή (μέχρι να επιλεγεί τιμή, η λίστα είναι κενή· δεν υπάρχει επιλογή «όλα»), η γενική επαναφορά δεν το καθαρίζει.

Τιμές:force_shownvalue_required

Παράδειγμα: value_required

typeobject (FilterEnum)

Φίλτρο-απαρίθμηση — επίπεδη λίστα τιμών απαρίθμησης

valuestring

Παράδειγμα: example

typestringυποχρεωτικό

Παράδειγμα: select

optionarray of string
modestring (FilterMode)

Πώς το περιβάλλον χειρίζεται το φίλτρο· το συνηθισμένο φίλτρο δεν έχει mode. Το force_shown — εμφανίζεται πάντα, δεν μπορεί να αποκρυφθεί. Το value_required — σημείο εισόδου στην ενότητα: εμφανίζεται πάντα, δεν έχει κενή τιμή (μέχρι να επιλεγεί τιμή, η λίστα είναι κενή· δεν υπάρχει επιλογή «όλα»), η γενική επαναφορά δεν το καθαρίζει.

Τιμές:force_shownvalue_required

Παράδειγμα: value_required

special_offer_idobject (FilterSelectInteger)
valueinteger

Παράδειγμα: 8920

typestringυποχρεωτικό

Παράδειγμα: select

optionarray of object
valueintegerυποχρεωτικό

Παράδειγμα: 8920

namestringυποχρεωτικό

Παράδειγμα: Green Basket | Kaliningrad

modestring (FilterMode)

Πώς το περιβάλλον χειρίζεται το φίλτρο· το συνηθισμένο φίλτρο δεν έχει mode. Το force_shown — εμφανίζεται πάντα, δεν μπορεί να αποκρυφθεί. Το value_required — σημείο εισόδου στην ενότητα: εμφανίζεται πάντα, δεν έχει κενή τιμή (μέχρι να επιλεγεί τιμή, η λίστα είναι κενή· δεν υπάρχει επιλογή «όλα»), η γενική επαναφορά δεν το καθαρίζει.

Τιμές:force_shownvalue_required

Παράδειγμα: value_required

platformobject (FilterEnum)

Φίλτρο-απαρίθμηση — επίπεδη λίστα τιμών απαρίθμησης

valuestring

Παράδειγμα: example

typestringυποχρεωτικό

Παράδειγμα: select

optionarray of string
modestring (FilterMode)

Πώς το περιβάλλον χειρίζεται το φίλτρο· το συνηθισμένο φίλτρο δεν έχει mode. Το force_shown — εμφανίζεται πάντα, δεν μπορεί να αποκρυφθεί. Το value_required — σημείο εισόδου στην ενότητα: εμφανίζεται πάντα, δεν έχει κενή τιμή (μέχρι να επιλεγεί τιμή, η λίστα είναι κενή· δεν υπάρχει επιλογή «όλα»), η γενική επαναφορά δεν το καθαρίζει.

Τιμές:force_shownvalue_required

Παράδειγμα: value_required

order_statusobject (FilterEnum)

Φίλτρο-απαρίθμηση — επίπεδη λίστα τιμών απαρίθμησης

valuestring

Παράδειγμα: example

typestringυποχρεωτικό

Παράδειγμα: select

optionarray of string
modestring (FilterMode)

Πώς το περιβάλλον χειρίζεται το φίλτρο· το συνηθισμένο φίλτρο δεν έχει mode. Το force_shown — εμφανίζεται πάντα, δεν μπορεί να αποκρυφθεί. Το value_required — σημείο εισόδου στην ενότητα: εμφανίζεται πάντα, δεν έχει κενή τιμή (μέχρι να επιλεγεί τιμή, η λίστα είναι κενή· δεν υπάρχει επιλογή «όλα»), η γενική επαναφορά δεν το καθαρίζει.

Τιμές:force_shownvalue_required

Παράδειγμα: value_required

payment_statusobject (FilterEnum)

Φίλτρο-απαρίθμηση — επίπεδη λίστα τιμών απαρίθμησης

valuestring

Παράδειγμα: example

typestringυποχρεωτικό

Παράδειγμα: select

optionarray of string
modestring (FilterMode)

Πώς το περιβάλλον χειρίζεται το φίλτρο· το συνηθισμένο φίλτρο δεν έχει mode. Το force_shown — εμφανίζεται πάντα, δεν μπορεί να αποκρυφθεί. Το value_required — σημείο εισόδου στην ενότητα: εμφανίζεται πάντα, δεν έχει κενή τιμή (μέχρι να επιλεγεί τιμή, η λίστα είναι κενή· δεν υπάρχει επιλογή «όλα»), η γενική επαναφορά δεν το καθαρίζει.

Τιμές:force_shownvalue_required

Παράδειγμα: value_required

delivery_methodobject (FilterEnum)

Φίλτρο-απαρίθμηση — επίπεδη λίστα τιμών απαρίθμησης

valuestring

Παράδειγμα: example

typestringυποχρεωτικό

Παράδειγμα: select

optionarray of string
modestring (FilterMode)

Πώς το περιβάλλον χειρίζεται το φίλτρο· το συνηθισμένο φίλτρο δεν έχει mode. Το force_shown — εμφανίζεται πάντα, δεν μπορεί να αποκρυφθεί. Το value_required — σημείο εισόδου στην ενότητα: εμφανίζεται πάντα, δεν έχει κενή τιμή (μέχρι να επιλεγεί τιμή, η λίστα είναι κενή· δεν υπάρχει επιλογή «όλα»), η γενική επαναφορά δεν το καθαρίζει.

Τιμές:force_shownvalue_required

Παράδειγμα: value_required

totalobject (SpecialOffersAnalyticsValues)
countintegerυποχρεωτικό

Παράδειγμα: 412

sumnumberυποχρεωτικό

Παράδειγμα: 531420.5

averagenumberυποχρεωτικό

Παράδειγμα: 1289.86

completed_countintegerυποχρεωτικό

Παραγγελίες που έφτασαν στην κατάσταση done ή confirmed

Παράδειγμα: 379

completed_sharenumberυποχρεωτικό

Ποσοστό ολοκληρωμένων παραγγελιών εντός αυτού του μισού, σε ποσοστό επί τοις εκατό

Παράδειγμα: 91.99

share_of_countnumberυποχρεωτικό

Ποσοστό όλων των παραγγελιών για την περίοδο, σε ποσοστό %

Παράδειγμα: 34.2

share_of_sumnumberυποχρεωτικό

Παράδειγμα: 29.7

segmentsarray of object
keystringυποχρεωτικό

Τι σημαίνει το μισό. Εάν έχει επιλεγεί promo code, τύπος προσφοράς ή συγκεκριμένη προσφορά, το πρώτο μισό περιορίζεται και το ζεύγος γίνεται matched_filter και rest. Ο παρονομαστής σε κάθε περίπτωση είναι όλες οι παραγγελίες της περιόδου. Ορίστε το μισό με βάση το key και όχι τη θέση.

Τιμές:with_promo_codewithout_promo_codematched_filterrest

Παράδειγμα: with_promo_code

valuesobject (SpecialOffersAnalyticsValues) υποχρεωτικό
countintegerυποχρεωτικό

Παράδειγμα: 412

sumnumberυποχρεωτικό

Παράδειγμα: 531420.5

averagenumberυποχρεωτικό

Παράδειγμα: 1289.86

completed_countintegerυποχρεωτικό

Παραγγελίες που έφτασαν στην κατάσταση done ή confirmed

Παράδειγμα: 379

completed_sharenumberυποχρεωτικό

Ποσοστό ολοκληρωμένων παραγγελιών εντός αυτού του μισού, σε ποσοστό επί τοις εκατό

Παράδειγμα: 91.99

share_of_countnumberυποχρεωτικό

Ποσοστό όλων των παραγγελιών για την περίοδο, σε ποσοστό %

Παράδειγμα: 34.2

share_of_sumnumberυποχρεωτικό

Παράδειγμα: 29.7

differenceobject

Η πρώτη τιμή μείον η δεύτερη, σε απόλυτες τιμές· τα ποσοστά αφαιρούνται σε μονάδες ποσοστού

countinteger

Παράδειγμα: -284

sumnumber

Παράδειγμα: -412300.1

averagenumber

Παράδειγμα: 180.4

completed_sharenumber

Παράδειγμα: -3.11