Get order heatmap by time
/api/crm/v2/orders_over_timev2ordersOverTime.defaultReturns an order heatmap: hours of the day by days of the week, calendar days, or months. Up to two periods can be returned per request to compare week-to-week or month-to-month data. Orders are aggregated by hour in UTC, and only non-empty hours are returned. Time zone conversion, row grouping, and empty cells are handled on the client side.
Authorization
api-token + language + role
Query parameters
Example: 25/04/2024
Example: 26/04/2024
Second period; empty if there is nothing to compare with
Example: 25/03/2024
Example: 26/03/2024
Grid rows: days of the week, calendar days, or months. Affects display only and never aggregation.
Values:weekdaydaymonth
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
Order platform
Values:androidapifbiosvksite
Delivery method: courier or pickup
Values:courierpickup
Payment status: unpaid, pending, paid
Values:not_paidwaitingpaid
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: 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 with no default value: default is always null.
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
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
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
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: 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
Values:ab
Example: a
Example: 25/04/2024
Example: 26/04/2024
Predefined period corresponding to the boundaries; null if the period is custom
Example: week
Example: 47
Example: 52640
Example: 1120
Orders grouped by hour; only non-empty hours. Convert the time to the user's time zone, then determine the row and column based on the result and fill missing values with zeros.
The hour to which the orders correspond, in UTC
Example: 2024-04-25 14:00:00
Example: 47
Example: 52640