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)

მიწოდების მეთოდი: კურიერი ან თვითგატანა

მნიშვნელობები: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)

ფილტრი-ჩამონათვალი — ბრტყელი ჩამონათვალი enum მნიშვნელობების

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)

ფილტრი-ჩამონათვალი — ბრტყელი ჩამონათვალი enum მნიშვნელობების

valuestring

მაგალითი: example

typestringსავალდებულო

მაგალითი: select

optionarray of string
modestring (FilterMode)

როგორ ამუშავებს ინტერფეისი ფილტრს; ჩვეულებრივ ფილტრს mode არ აქვს. force_shown — ყოველთვის ნაჩვენებია, დამალვა შეუძლებელია. value_required — განყოფილების შესვლის წერტილი: ყოველთვის ნაჩვენებია, ცარიელი მნიშვნელობა არ აქვს (სანამ მნიშვნელობა არ არის არჩეული, სია ცარიელია; ვარიანტი „ყველა“ არ არსებობს), საერთო გასუფთავება მას არ აშორებს.

მნიშვნელობები:force_shownvalue_required

მაგალითი: value_required

order_statusobject (FilterEnum)

ფილტრი-ჩამონათვალი — ბრტყელი ჩამონათვალი enum მნიშვნელობების

valuestring

მაგალითი: example

typestringსავალდებულო

მაგალითი: select

optionarray of string
modestring (FilterMode)

როგორ ამუშავებს ინტერფეისი ფილტრს; ჩვეულებრივ ფილტრს mode არ აქვს. force_shown — ყოველთვის ნაჩვენებია, დამალვა შეუძლებელია. value_required — განყოფილების შესვლის წერტილი: ყოველთვის ნაჩვენებია, ცარიელი მნიშვნელობა არ აქვს (სანამ მნიშვნელობა არ არის არჩეული, სია ცარიელია; ვარიანტი „ყველა“ არ არსებობს), საერთო გასუფთავება მას არ აშორებს.

მნიშვნელობები:force_shownvalue_required

მაგალითი: value_required

payment_statusobject (FilterEnum)

ფილტრი-ჩამონათვალი — ბრტყელი ჩამონათვალი enum მნიშვნელობების

valuestring

მაგალითი: example

typestringსავალდებულო

მაგალითი: select

optionarray of string
modestring (FilterMode)

როგორ ამუშავებს ინტერფეისი ფილტრს; ჩვეულებრივ ფილტრს mode არ აქვს. force_shown — ყოველთვის ნაჩვენებია, დამალვა შეუძლებელია. value_required — განყოფილების შესვლის წერტილი: ყოველთვის ნაჩვენებია, ცარიელი მნიშვნელობა არ აქვს (სანამ მნიშვნელობა არ არის არჩეული, სია ცარიელია; ვარიანტი „ყველა“ არ არსებობს), საერთო გასუფთავება მას არ აშორებს.

მნიშვნელობები:force_shownvalue_required

მაგალითი: value_required

delivery_methodobject (FilterEnum)

ფილტრი-ჩამონათვალი — ბრტყელი ჩამონათვალი enum მნიშვნელობების

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სავალდებულო

რას ნიშნავს ნახევარი. თუ არჩეულია პრომოკოდი, აქციის ტიპი ან კონკრეტული აქცია, პირველი ნახევარი ვიწროვდება და წყვილი ხდება 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