Get special offers analytics
/api/crm/v2/special_offers_analyticsv2specialOffersAnalytics.defaultAuthorization
api-token + language + role
Query parameters
Example: 25/04/2024
Example: 26/04/2024
Example: SALE20
Example: percent_discount_on_all_order
Example: 152410
Order platform
Values:androidapifbiosvksite
Order status: on the way, completed, assembling, in the kitchen, not processed, ready for dispatch, waiting to be sent to kitchen, waiting for remake, cancelled, confirmed, prepared
Values:in_transitdoneassemblyin_kitchennot_processedready_to_transitwait_to_kitchenwait_remadecanceledconfirmedcooked
Example: confirmed
Payment status: unpaid, pending, paid
Values:not_paidwaitingpaid
Delivery method: courier or pickup
Values:courierpickup
Responses
OK
Values:successerror
Example: success
Example: 2026-08-01 00:00:00
Example: date
How the interface handles the filter; a regular filter does not have mode.
force_shown — always displayed, cannot be hidden.
value_required — entry point to the section: always displayed, cannot have an empty value (until a value is selected, the list is empty; there is no "all" option), global reset does not clear it.
Values:force_shownvalue_required
Example: value_required
Example: 2026-08-31 23:59:59
Example: date
How the interface handles the filter; a regular filter does not have mode.
force_shown — always displayed, cannot be hidden.
value_required — entry point to the section: always displayed, cannot have an empty value (until a value is selected, the list is empty; there is no "all" option), global reset does not clear it.
Values:force_shownvalue_required
Example: value_required
Predefined date filter ranges; the lower boundary is calculated in the user's timezone. value is the range corresponding to the current *_from and *_to; null means a custom range. default is the range the server uses when a request has no dates: it is also applied on the first section load and when resetting. The upper boundary of the range always matches the user's current day, so option does not include it: you do not need to send *_to for a predefined range, the server sets it automatically. Ranges longer than one year are trimmed from the most recent boundary.
Predefined date filter range. It does not have its own query parameter: the lower boundary is pre-calculated in option and is used as *_from. The upper boundary is neither returned in the response nor sent in the request—it is always set to the user's current day by the server.
Values:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear
Example: today
Predefined date filter range. It does not have its own query parameter: the lower boundary is pre-calculated in option and is used as *_from. The upper boundary is neither returned in the response nor sent in the request—it is always set to the user's current day by the server.
Values:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear
Example: today
Example: select
How the interface handles the filter; a regular filter does not have mode.
force_shown — always displayed, cannot be hidden.
value_required — entry point to the section: always displayed, cannot have an empty value (until a value is selected, the list is empty; there is no "all" option), global reset does not clear it.
Values:force_shownvalue_required
Example: value_required
Predefined date filter range. It does not have its own query parameter: the lower boundary is pre-calculated in option and is used as *_from. The upper boundary is neither returned in the response nor sent in the request—it is always set to the user's current day by the server.
Values:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear
Example: today
Example: 25/08/2026
Example: 8920
Example: select
Example: 8920
Example: Green Basket | Kaliningrad
How the interface handles the filter; a regular filter does not have mode.
force_shown — always displayed, cannot be hidden.
value_required — entry point to the section: always displayed, cannot have an empty value (until a value is selected, the list is empty; there is no "all" option), global reset does not clear it.
Values:force_shownvalue_required
Example: value_required
Example: 8920
Example: select
Example: 8920
Example: Green Basket | Kaliningrad
How the interface handles the filter; a regular filter does not have mode.
force_shown — always displayed, cannot be hidden.
value_required — entry point to the section: always displayed, cannot have an empty value (until a value is selected, the list is empty; there is no "all" option), global reset does not clear it.
Values:force_shownvalue_required
Example: value_required
Example: example
Example: integer or string
Example: string
How the interface handles the filter; a regular filter does not have mode.
force_shown — always displayed, cannot be hidden.
value_required — entry point to the section: always displayed, cannot have an empty value (until a value is selected, the list is empty; there is no "all" option), global reset does not clear it.
Values:force_shownvalue_required
Example: value_required
Filter enumeration — a flat list of enumeration values
Example: example
Example: select
How the interface handles the filter; a regular filter does not have mode.
force_shown — always displayed, cannot be hidden.
value_required — entry point to the section: always displayed, cannot have an empty value (until a value is selected, the list is empty; there is no "all" option), global reset does not clear it.
Values:force_shownvalue_required
Example: value_required
Example: 8920
Example: select
Example: 8920
Example: Green Basket | Kaliningrad
How the interface handles the filter; a regular filter does not have mode.
force_shown — always displayed, cannot be hidden.
value_required — entry point to the section: always displayed, cannot have an empty value (until a value is selected, the list is empty; there is no "all" option), global reset does not clear it.
Values:force_shownvalue_required
Example: value_required
Filter enumeration — a flat list of enumeration values
Example: example
Example: select
How the interface handles the filter; a regular filter does not have mode.
force_shown — always displayed, cannot be hidden.
value_required — entry point to the section: always displayed, cannot have an empty value (until a value is selected, the list is empty; there is no "all" option), global reset does not clear it.
Values:force_shownvalue_required
Example: value_required
Filter enumeration — a flat list of enumeration values
Example: example
Example: select
How the interface handles the filter; a regular filter does not have mode.
force_shown — always displayed, cannot be hidden.
value_required — entry point to the section: always displayed, cannot have an empty value (until a value is selected, the list is empty; there is no "all" option), global reset does not clear it.
Values:force_shownvalue_required
Example: value_required
Filter enumeration — a flat list of enumeration values
Example: example
Example: select
How the interface handles the filter; a regular filter does not have mode.
force_shown — always displayed, cannot be hidden.
value_required — entry point to the section: always displayed, cannot have an empty value (until a value is selected, the list is empty; there is no "all" option), global reset does not clear it.
Values:force_shownvalue_required
Example: value_required
Filter enumeration — a flat list of enumeration values
Example: example
Example: select
How the interface handles the filter; a regular filter does not have mode.
force_shown — always displayed, cannot be hidden.
value_required — entry point to the section: always displayed, cannot have an empty value (until a value is selected, the list is empty; there is no "all" option), global reset does not clear it.
Values:force_shownvalue_required
Example: value_required
Example: 412
Example: 531420.5
Example: 1289.86
Orders that have reached the done or confirmed status
Example: 379
The percentage of completed orders within this half
Example: 91.99
Share of all orders in the period, in percent
Example: 34.2
Example: 29.7
What does half mean. If a promo code, promotion type, or specific promotion is selected, the first half is narrowed, and the pair becomes matched_filter and rest; the denominator is always all orders for the period. Determine the half by key, not by position.
Values:with_promo_codewithout_promo_codematched_filterrest
Example: with_promo_code
Example: 412
Example: 531420.5
Example: 1289.86
Orders that have reached the done or confirmed status
Example: 379
The percentage of completed orders within this half
Example: 91.99
Share of all orders in the period, in percent
Example: 34.2
Example: 29.7
The first value minus the second, in absolute terms; shares are subtracted in percentage points
Example: -284
Example: -412300.1
Example: 180.4
Example: -3.11