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)

Զտիչ-թվարկում — թվարկման արժեքների հարթ ցուցակ

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պարտադիր

Ի՞նչ է նշանակում կեսը։ Եթե ընտրված է պրոմոկոդ, ակցիայի տիպ կամ կոնկրետ ակցիա, առաջին կեսը նեղացվում է, և զույգը դառնում է 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