| Data Dimension Authorization | Enterprise-level Authorization | This API requires enterprise-level authorization. Both enterprise-level and agent-level authorization accounts can call this API. Please refer to Authorization Methods. |
| Interface Dimension Authorization | Default Authorization | This API is granted by default, so you don't need to apply for interface dimension authorization separately for your authorization account. Please refer to Authorization Methods. |
| HTTP URL Path | /proxyopen/dataopen/applet_zcb_item_line |
| HTTP Method | POST |
| Content-Type | application/x-www-form-urlencoded |
Request Body Parameters
| Parameter | Type | Required | Description |
| ov_corpid | string | Yes | Enterprise ID. Use commas to separate multiple enterprise IDs. |
| classify | string | Yes | Data type. Please refer to the explanation of the Request Body Parameter classify below. |
| compare | string | Yes | |
| product_line | string | No | Robot model. If this parameter is passed, only data for this model of robot will be queried. For example: OS-R-DR01S |
| devices | string | No | Robot SN. Use commas to separate multiple SNs. |
| timezone | string | Yes | Timezone. The value is a positive or negative integer or 0 representing the timezone. For example: +1, 0, -2 |
Request Body Parameter classify
| Value of classify | Data Name | Description |
| b_delivery_nums | Deliveries to Table | Sum of tables delivered for Delivery Mode |
| b_guide_nums | Leading Records | Sum of Guidance task execution times |
| b_snack_seconds | Cruising Minutes | Total duration of the cruise (minutes) |
| adv_wakeup_num | Passing-by persons | Passenger flow statistics in Promotion Mode (That is: the number of times the robot actively broadcasts welcome words within 1-2 meters) |
| run_mileage | Running Mileage | Distance travelled (meters) |
| ad_show_nums | Greeting Ad Plays | The number of times ads played in Promotion Mode |
| wakeup_num | Interaction People | The number of times of wake-up in Promotion mod |
| voice_query_num | Voice Interaction | Number of voice conversations |
| active_hour | Active Hour | Working hours of the robot (hours when it is powered on and connected to the Internet) |
| b_snack_rounds | Cruising Rounds | Rounds of Cruising task |
# Please replace the entry point with yours according to your region
curl --location 'https://openapi.orionstar.com/proxyopen/dataopen/applet_zcb_item_line' \
--header 'Authorization: Bearer YOUR-ACCESS-TOKEN' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'ov_corpid=test_ov_corpid' \
--data-urlencode 'classify=b_delivery_nums' \
--data-urlencode 'compare=2024-02-01,2024-02-03' \
--data-urlencode 'devices=test_sn' \
--data-urlencode 'timezone=0'
Common Response Body
| Parameter | Type | Description |
| code | int | Error code. 200 means success, non-200 means failure, Please refer to Error Codes. |
| msg | string | Error description. When there is a failure, a specific error description will be provided. |
| data | object | Business data object, see below for details Response Body Data Object. |
Response Body Data Object
| Parameter | Type | Description |
| list | array | An array of usage data lists, where each element corresponds to the data value corresponding to the data type passed in. Please refer to the Response Body Example below. |
| list[].name | string | Name of the data type. Please refer to the explanation of the Request Body Parameter classify. |
| list[].list | array | An array of data values, where each element represents the data values for each day (or each hour), and the index of the array corresponds to the time list array in weeklist. |
| weeklist | array | A list array of time. If queried by day, it returns a list of dates; if queried by hour, it returns a list of hours. Please refer to the Response Body Example below. |
Response Body Example
{
"code": 200,
"msg": "",
"data": {
"list": [
{
"name": "Delivery To Table",
"list": [
20,
28,
17
]
}
],
"weeklist": [
"2024-02-01",
"2024-02-02",
"2024-02-03"
]
}
}
{
"code": 200,
"msg": "",
"data": {
"list": [
{
"name": "Leading Records",
"list": [
8,
10,
15
]
}
],
"weeklist": [
"2024-02-01",
"2024-02-02",
"2024-02-03"
]
}
}
{
"code": 200,
"msg": "",
"data": {
"list": [
{
"name": "Delivery To Table",
"list": [
0,
0,
0,
0,
0,
0,
0,
0,
5,
3,
7,
2,
6,
10,
4,
2,
8,
7,
12,
6,
3,
0,
0,
0
]
}
],
"weeklist": [
"0",
"1",
"2",
"3",
"4",
"5",
"6",
"7",
"8",
"9",
"10",
"11",
"12",
"13",
"14",
"15",
"16",
"17",
"18",
"19",
"20",
"21",
"22",
"23"
]
}
}