Table of Contents

招财豹使用数据查询

概述

授权方式

数据维度授权 企业级授权 此 API 为企业级授权，企业级授权和代理商级授权的授权账号均可以调用此 API。请参考 授权方式。
接口维度授权 默认授权 此 API 为默认授权，您无需为您的授权账号额外申请接口维度授权就可以调用。请参考 授权方式。

请求

请求域名

区域 域名
中国区 https://openapi.orionstar.com
欧洲区 https://global-openapi.orionstar.com
美国区 https://us-openapi.orionstar.com
日本区 https://jp-openapi.orionstar.com

请求协议

HTTP URL 路径 /proxyopen/dataopen/applet_zcb_item_line
HTTP Method POST
Content-Type application/x-www-form-urlencoded

公共请求头

参数 类型 必填 说明
Authorization string 是
  • 访问凭证 access_token
  • 格式：Bearer access_token
  • 示例：Bearer T.WcnhSdYj-kwVBpP27LRQrw.OBt95zE4TH-OPzIX6OkEWPo4rbR6s.ori-67facfd90b2744220a5eae850e51
  • 请参考：鉴权方法

请求体参数

参数 类型 必填 参数说明
ov_corpid string 是 企业 id。多个企业 id 请使用英文逗号分隔。
classify string 是 数据类型，请参考下面 请求体 classify 参数说明
compare string 是
  • 需要查询的日期范围；
  • 如果传入的是用逗号分隔的起始日期和结束日期区间，则按照天查询此区间内的分天数据；
  • 如果只传入一个日期值，则按照小时查询这一天的分小时数据；
  • 日期的格式为：YYYY-MM-DD
  • 例如：
    • 2024-02-01,2024-02-03
      • 表示按照天查询从 2024-02-01 到 2024-02-03 这 3 天的分天数据；
    • 2024-02-01
      • 表示按照小时查询 2024-02-01 这 1 天的分小时数据；
product_line string 否 机器人型号，如果传递了此参数则只查询此型号机器人的数据。例如：OS-R-DR01S
devices string 否 机器人 SN，多个 SN 请使用英文逗号分隔。

请求体 classify 参数说明

classify 取值 数据名称 说明
b_delivery_nums Deliveries to Table 送餐模式的递送总桌数
b_guide_nums Leading Records 领位任务的执行总次数
b_snack_seconds Cruising Minutes 巡航总时长（分钟）
adv_wakeup_num Passing-by persons 揽客模式下的客流量统计（机器人在 1-2 米范围内主动播放欢迎语的次数）
run_mileage Running Mileage 机器人的运行里程（米）
ad_show_nums Greeting Ad Plays 揽客广告的播放总次数
wakeup_num Interaction People 揽客模式唤醒次数
voice_query_num Voice Interaction 语音对话的次数
active_hour Active Hour 机器人工作时长（开机联网的小时数）
b_snack_rounds Cruising Rounds 巡航导航状态下的运动总圈数

请求 cURL 示例

# 请根据您的区域替换域名
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_robot_sn'

响应

公共响应体

参数 类型 参数说明
code int 错误代码。200 是成功，非 200 是失败，请参考 错误代码。
msg string 错误描述，当失败的时候会给出具体的错误描述。
data object 业务数据 data 对象，详见下述 响应体 data 对象。

响应体 data 对象

参数 类型 参数说明
list array 使用数据的列表数组，数组中的元素即为传入的数据类型对应的数据，请参考下面 响应体示例。
list[].name string 数据类型名称，请参考上面 请求体 classify 参数说明。
list[].list array 数据值组成的列表数组，数组中的每个元素都是分天（或分小时）的数据值，数组的下标与 weeklist 对应的时间列表数组是对应的。
weeklist array 时间的列表数组。如果是按照天查询则返回的是日期列表，如果是按照小时查询返回的是小时列表，请参考下面 响应体示例。

响应体示例

分天数据示例

{
    "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"
        ]
    }
}