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)
valuestringnull мәнін қабылдай алады

Мысал: 2026-08-01 00:00:00

typestringміндетті

Мысал: date

modestring (FilterMode)

Интерфейс сүзгіні қалай өңдейді; кәдімгі сүзгіде mode жоқ. force_shown — әрқашан көрсетіледі, жасыруға болмайды. value_required — бөлімге кіру нүктесі: әрқашан көрсетіледі, бос мәні болмайды (мән таңдалмағанша, тізім бос; «барлығы» нұсқасы жоқ), жалпы тазарту оны өшірмейді.

Мәндер:force_shownvalue_required

Мысал: value_required

date_creation_toobject (FilterDateTo)
valuestringnull мәнін қабылдай алады

Мысал: 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