List of mapped order statuses
Returns the list of order statuses from the CRM system mapped to status types in Yandex Metrica.
You need status types to connect order statuses to sessions and to see statistics broken down by status.
The session reports display status types predefined in Yandex Metrica. Custom status names will be available in the Users and customers — Customers report.
Request
GET
https://api-metrika.yandex.net/cdp/api/v1/counter/{counterId}/schema/order_statuses
Path parameters
Name |
Description |
counterId* |
Type: integer<int32> Counter ID. |
Responses
200 OK
OK
Body
application/json
{
"order_statuses": [
{
"id": "string",
"humanized": "string",
"type": "string",
"goal_action_ids": [
"string"
]
}
]
}
Name |
Description |
order_statuses* |
Type: OrderStatus[] List of order statuses. |
OrderStatus
Description of the OrderStatus
object.
Name |
Description |
id* |
Type: string Order status ID. Min length: Max length: Pattern: |
type* |
Type: string Status semantics:
|
goal_action_ids |
Type: string[] Goal IDs Min items: Max items: Unique items |
humanized |
Type: string Order status name. Min length: Max length: |
No longer supported, please use an alternative and newer version.