Table of Contents

豹小秘使用数据查询

概述

公共授权方式

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

公共请求

公共请求协议

请求域名 https://openapi.orionstar.com
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
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 否 机器人型号，如果传递了此参数则只查询此型号机器人的数据。例如：CM-GB01N
devices string 否 机器人 SN，多个 SN 请使用英文逗号分隔。
pageIndex int 否 明细分页参数，当前是第几页，从 1 开始，默认是 1。
pageSize int 否 明细分页参数，每页多少条数据，默认是 10，不建议超过 50。

公共响应

公共响应体

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

响应体通用参数

参数 类型 参数说明
count_time string 数据统计日期，格式为：YYYY-MM-DD，例如：2024-02-01
version string 机器人系统主版本号
device_id string 机器人 sn
device_name string 机器人名称
enterprise_id string 企业 id
enterprise_name string 企业名称

API 列表

分类 HTTP URL 路径 名称 更新时间 说明
功能指标数据 /proxyopen/dataopen/flow_list 客流和招揽汇总 准实时 豹小秘 V6.4 以上版本不支持客流数据。分版本分设备维度日汇总。
/proxyopen/dataopen/wakeup_detail_list 唤醒汇总 准实时 分版本分设备维度日汇总
/proxyopen/dataopen/machine_interaction_list 交互汇总 准实时 分版本分设备维度日汇总
/proxyopen/dataopen/machine_guide_introduction_list 导览汇总 准实时 分版本分设备维度日分导览名称汇总
/proxyopen/dataopen/machine_patrol_introduction_list 巡逻汇总 每日 6 点前更新 分版本分设备维度日汇总
/proxyopen/dataopen/machine_guide_list 引领汇总 准实时 分版本分设备维度分地点日汇总
/proxyopen/dataopen/machine_ask_list 问路汇总 准实时 分版本分设备维度日汇总
/proxyopen/dataopen/machine_reception_introduction_list 来访接待汇总 准实时 分版本分设备维度分接待名称日汇总
/proxyopen/dataopen/machine_dialog_list 语音对话次数汇总 准实时 分版本分设备维度日汇总
/proxyopen/dataopen/percent_dialog_mode_count 语音对话领域汇总 每日 6 点前更新 分领域汇总
/proxyopen/dataopen/voice_list 语音对话明细 准实时 对话明细
问答交互二次分析数据 /proxyopen/dataopen/entity_words_cloud_open 关键词词云汇总 每日 6 点前更新 最大返回100条，不支持翻页。分企业时间段汇总。
/proxyopen/dataopen/percent_interaction_mode_count 不同交互类型占比汇总 每日 6 点前更新 分企业时间段汇总
用户画像数据 /proxyopen/dataopen/crowd_analysis_overview 用户画像占比汇总 每日 9 点前更新 分企业时间段汇总

● 客流和招揽汇总

请求

请求协议

公共请求协议请参考 公共请求协议

HTTP URL 路径 /proxyopen/dataopen/flow_list

请求头

公共请求头请参考 公共请求头

请求体参数

公共请求体参数请参考 公共请求体参数

参数 类型 必填 参数说明
person_type string 是 汇总类型。
flow：客流数据
advance：招揽数据

请求 cURL 示例

curl --location 'https://openapi.orionstar.com/proxyopen/dataopen/flow_list' \
     --header 'Authorization: Bearer YOUR-ACCESS-TOKEN' \
     --header 'Content-Type: application/x-www-form-urlencoded' \
     --data-urlencode 'ov_corpid=test_ov_corpid' \
     --data-urlencode 'compare=2024-02-01,2024-02-03' \
     --data-urlencode 'person_type=flow'

响应

响应体 data 对象

公共响应体请参考 公共响应 和 响应体通用参数

参数 类型 参数说明
list array 数据列表数组
list[].person_num string 当日客流或招揽汇总

响应体示例

{
    "code": 200,
    "msg": "",
    "data": {
        "list": [
            {
                "enterprise_id": "orion.ovs.entprise.123456",
                "device_id": "74314b9e2019101118",
                "model": "豹花瓶",
                "os_type": "2",
                "name": "2024-02-01",
                "count_time": "2024-02-01",
                "dates": "2024-02-01",
                "version": "V4.12",
                "opk": null,
                "person_num": "578",
                "enterprise_name": "猎户星空",
                "pcate_name": "企业",
                "cate_name": "餐厅",
                "city": "北京市",
                "agency_name": null,
                "device_name": "豹1号"
            }
        ],
        "pagination": {
            "pageIndex": 1,
            "pageSize": 2,
            "total": 1
        }
    }
}

● 唤醒汇总

请求

请求协议

公共请求协议请参考 公共请求协议

HTTP URL 路径 /proxyopen/dataopen/wakeup_detail_list

请求头

公共请求头请参考 公共请求头

请求体参数

公共请求体参数请参考 公共请求体参数

请求 cURL 示例

curl --location 'https://openapi.orionstar.com/proxyopen/dataopen/wakeup_detail_list' \
     --header 'Authorization: Bearer YOUR-ACCESS-TOKEN' \
     --header 'Content-Type: application/x-www-form-urlencoded' \
     --data-urlencode 'ov_corpid=test_ov_corpid' \
     --data-urlencode 'compare=2024-02-01,2024-02-03'

响应

响应体 data 对象

公共响应体请参考 公共响应 和 响应体通用参数

参数 类型 参数说明
list array 数据列表数组
list[].num string 当日唤醒次数

响应体示例

{
    "code": 200,
    "msg": "",
    "data": {
        "list": [
            {
                "device_id": "test_sn_1",
                "enterprise_id": "orion.ovs.entprise.123456",
                "version": "V6.5",
                "opk": "02.0008.21040118",
                "num": "317",
                "count_time": "2024-02-01",
                "enterprise_name": "猎户星空",
                "pcate_name": "企业",
                "cate_name": "餐厅",
                "city": "北京市",
                "agency_name": null,
                "device_name": "test1"
            }
        ],
        "pagination": {
            "total": 11,
            "pageIndex": 1,
            "pageSize": 1
        }
    }
}

● 交互汇总

请求

请求协议

公共请求协议请参考 公共请求协议

HTTP URL 路径 /proxyopen/dataopen/machine_interaction_list

请求头

公共请求头请参考 公共请求头

请求体参数

公共请求体参数请参考 公共请求体参数

请求 cURL 示例

curl --location 'https://openapi.orionstar.com/proxyopen/dataopen/machine_interaction_list' \
     --header 'Authorization: Bearer YOUR-ACCESS-TOKEN' \
     --header 'Content-Type: application/x-www-form-urlencoded' \
     --data-urlencode 'ov_corpid=test_ov_corpid' \
     --data-urlencode 'compare=2024-02-01,2024-02-03'

响应

响应体 data 对象

公共响应体请参考 公共响应 和 响应体通用参数

参数 类型 参数说明
list array 数据列表数组
list[].num int 当日交互次数

响应体示例

{
    "code": 200,
    "msg": "",
    "data": {
        "list": [
            {
                "count_time": "2024-02-01",
                "num": 166,
                "num1": 166,
                "device_id": "test_sn_1",
                "enterprise_id": "orion.ovs.entprise.123456",
                "version": "V6.4",
                "opk": "03.0003.21040121",
                "enterprise_name": "猎户星空",
                "pcate_name": "企业",
                "cate_name": "餐厅",
                "city": "北京市",
                "agency_name": null,
                "device_name": "小豹77号"
            }
        ],
        "pagination": {
            "total": 12,
            "pageIndex": 1,
            "pageSize": 1
        }
    }
}

● 导览汇总

请求

请求协议

公共请求协议请参考 公共请求协议

HTTP URL 路径 /proxyopen/dataopen/machine_guide_introduction_list

请求头

公共请求头请参考 公共请求头

请求体参数

公共请求体参数请参考 公共请求体参数

请求 cURL 示例

curl --location 'https://openapi.orionstar.com/proxyopen/dataopen/machine_guide_introduction_list' \
     --header 'Authorization: Bearer YOUR-ACCESS-TOKEN' \
     --header 'Content-Type: application/x-www-form-urlencoded' \
     --data-urlencode 'ov_corpid=test_ov_corpid' \
     --data-urlencode 'compare=2024-02-01,2024-02-03'

响应

响应体 data 对象

公共响应体请参考 公共响应 和 响应体通用参数

参数 类型 参数说明
list array 数据列表数组
list[].line_name string 导览名称
list[].num string 次数
list[].guide_duration float 时长（s）
list[].finish_num string 完成率（%）

响应体示例

{
    "code": 200,
    "msg": "",
    "data": {
        "list": [
            {
                "count_time": "2024-02-01",
                "num": "2",
                "line_name": "猎户星空导览",
                "device_id": "test_sn",
                "enterprise_id": "orion.ovs.entprise.123456",
                "version": "V6.3",
                "finish_num": "0.00",
                "duration_avg": 0,
                "guide_duration": 112.03,
                "enterprise_name": "猎户星空",
                "pcate_name": "企业",
                "cate_name": "餐厅",
                "city": "北京市",
                "agency_name": null,
                "device_name": "test_name"
            }
        ],
        "pagination": {
            "total": 3,
            "pageIndex": 1,
            "pageSize": 1
        }
    }
}

● 巡逻汇总

请求

请求协议

公共请求协议请参考 公共请求协议

HTTP URL 路径 /proxyopen/dataopen/machine_patrol_introduction_list

请求头

公共请求头请参考 公共请求头

请求体参数

公共请求体参数请参考 公共请求体参数

请求 cURL 示例

curl --location 'https://openapi.orionstar.com/proxyopen/dataopen/machine_patrol_introduction_list' \
     --header 'Authorization: Bearer YOUR-ACCESS-TOKEN' \
     --header 'Content-Type: application/x-www-form-urlencoded' \
     --data-urlencode 'ov_corpid=test_ov_corpid' \
     --data-urlencode 'compare=2024-02-01,2024-02-03'

响应

响应体 data 对象

公共响应体请参考 公共响应 和 响应体通用参数

参数 类型 参数说明
list array 数据列表数组
list[].num string 次数
list[].guide_duration float 时长（s）

响应体示例

{
    "code": 200,
    "msg": "",
    "data": {
        "list": [
            {
                "count_time": "2024-02-01",
                "num": "242",
                "device_id": "test_sn",
                "enterprise_id": "orion.ovs.entprise.2413674089",
                "version": "V6.3",
                "finish_num": "0.00",
                "guide_duration": 39214.27,
                "enterprise_name": "猎户星空",
                "pcate_name": "企业",
                "cate_name": "餐厅",
                "city": "北京市",
                "agency_name": null,
                "device_name": "test_name"
            }
        ],
        "pagination": {
            "total": 1,
            "pageIndex": 1,
            "pageSize": 1
        }
    }
}

● 引领汇总

请求

请求协议

公共请求协议请参考 公共请求协议

HTTP URL 路径 /proxyopen/dataopen/machine_guide_list

请求头

公共请求头请参考 公共请求头

请求体参数

公共请求体参数请参考 公共请求体参数

请求 cURL 示例

curl --location 'https://openapi.orionstar.com/proxyopen/dataopen/machine_guide_list' \
     --header 'Authorization: Bearer YOUR-ACCESS-TOKEN' \
     --header 'Content-Type: application/x-www-form-urlencoded' \
     --data-urlencode 'ov_corpid=test_ov_corpid' \
     --data-urlencode 'compare=2024-02-01,2024-02-03'

响应

响应体 data 对象

公共响应体请参考 公共响应 和 响应体通用参数

参数 类型 参数说明
list array 数据列表数组
list[].line_name string 引领地点
list[].num string 次数
list[].finish_num string 完成次数
list[].duration_num float 总耗时
list[].lead_num int 引领次数

响应体示例

{
    "code": 200,
    "msg": "",
    "data": {
        "list": [
            {
                "line_name": "洗手间",
                "count_time": "2024-02-01",
                "num": "1",
                "finish_num": "1",
                "finish_rate": "100.00",
                "duration_avg": 52.8,
                "duration_num": 52.8,
                "lead_num": 1,
                "device_id": "test_sn",
                "enterprise_id": "orion.ovs.entprise.123456",
                "version": "V6.5",
                "enterprise_name": "猎户星空",
                "pcate_name": "企业",
                "cate_name": "餐厅",
                "city": "北京市",
                "agency_name": null,
                "device_name": "test_name"
            }
        ],
        "pagination": {
            "total": 1,
            "pageIndex": 1,
            "pageSize": 2
        }
    }
}

● 问路汇总

请求

请求协议

公共请求协议请参考 公共请求协议

HTTP URL 路径 /proxyopen/dataopen/machine_ask_list

请求头

公共请求头请参考 公共请求头

请求体参数

公共请求体参数请参考 公共请求体参数

请求 cURL 示例

curl --location 'https://openapi.orionstar.com/proxyopen/dataopen/machine_ask_list' \
     --header 'Authorization: Bearer YOUR-ACCESS-TOKEN' \
     --header 'Content-Type: application/x-www-form-urlencoded' \
     --data-urlencode 'ov_corpid=test_ov_corpid' \
     --data-urlencode 'compare=2024-02-01,2024-02-03'

响应

响应体 data 对象

公共响应体请参考 公共响应 和 响应体通用参数

参数 类型 参数说明
list array 数据列表数组
list[].num string 次数

响应体示例

{
    "code": 200,
    "msg": "",
    "data": {
        "list": [
            {
                "count_time": "2024-02-01",
                "num": "1",
                "device_id": "test_sn",
                "enterprise_id": "orion.ovs.entprise.123456",
                "version": "V6.4",
                "enterprise_name": "猎户星空",
                "pcate_name": "企业",
                "cate_name": "餐厅",
                "city": "北京市",
                "agency_name": null,
                "device_name": "小豹77号"
            }
        ],
        "pagination": {
            "total": 2,
            "pageIndex": 1,
            "pageSize": 1
        }
    }
}

● 来访接待汇总

请求

请求协议

公共请求协议请参考 公共请求协议

HTTP URL 路径 /proxyopen/dataopen/machine_reception_introduction_list

请求头

公共请求头请参考 公共请求头

请求体参数

公共请求体参数请参考 公共请求体参数

请求 cURL 示例

curl --location 'https://openapi.orionstar.com/proxyopen/dataopen/machine_reception_introduction_list' \
     --header 'Authorization: Bearer YOUR-ACCESS-TOKEN' \
     --header 'Content-Type: application/x-www-form-urlencoded' \
     --data-urlencode 'ov_corpid=test_ov_corpid' \
     --data-urlencode 'compare=2024-02-01,2024-02-03'

响应

响应体 data 对象

公共响应体请参考 公共响应 和 响应体通用参数

参数 类型 参数说明
list array 数据列表数组
list[].line_name string 接待名称
list[].num string 次数
list[].guide_duration float 时长（s）
list[].finish_num string 完成率（%）

响应体示例

{
    "code": 200,
    "msg": "",
    "data": {
        "list": [
            {
                "line_name": "其它",
                "count_time": "2024-02-01",
                "num": "1",
                "device_id": "test_sn",
                "enterprise_id": "orion.ovs.entprise.123456",
                "version": "V6.5",
                "finish_num": "100.00",
                "guide_duration": 15.59,
                "enterprise_name": "猎户星空",
                "pcate_name": "企业",
                "cate_name": "餐厅",
                "city": "北京市",
                "agency_name": null,
                "device_name": "test_name"
            }
        ],
        "pagination": {
            "total": 1,
            "pageIndex": 1,
            "pageSize": 2
        }
    }
}

● 语音对话次数汇总

请求

请求协议

公共请求协议请参考 公共请求协议

HTTP URL 路径 /proxyopen/dataopen/machine_dialog_list

请求头

公共请求头请参考 公共请求头

请求体参数

公共请求体参数请参考 公共请求体参数

请求 cURL 示例

curl --location 'https://openapi.orionstar.com/proxyopen/dataopen/machine_dialog_list' \
     --header 'Authorization: Bearer YOUR-ACCESS-TOKEN' \
     --header 'Content-Type: application/x-www-form-urlencoded' \
     --data-urlencode 'ov_corpid=test_ov_corpid' \
     --data-urlencode 'compare=2024-02-01,2024-02-03'

响应

响应体 data 对象

公共响应体请参考 公共响应 和 响应体通用参数

参数 类型 参数说明
list array 数据列表数组
list[].num int 当日该设备对话总数

响应体示例

{
    "code": 200,
    "msg": "",
    "data": {
        "list": [
            {
                "count_time": "2024-02-01",
                "num": 98,
                "device_id": "test_sn",
                "enterprise_id": "orion.ovs.entprise.123456",
                "version": "V6.4",
                "enterprise_name": "猎户星空",
                "pcate_name": "企业",
                "cate_name": "餐厅",
                "city": "北京市",
                "agency_name": null,
                "device_name": "小豹77号"
            }
        ],
        "pagination": {
            "total": 10,
            "pageIndex": 1,
            "pageSize": 1
        }
    }
}

● 语音对话领域汇总

请求

请求协议

公共请求协议请参考 公共请求协议

HTTP URL 路径 /proxyopen/dataopen/percent_dialog_mode_count

请求头

公共请求头请参考 公共请求头

请求体参数

公共请求体参数请参考 公共请求体参数

请求 cURL 示例

curl --location 'https://openapi.orionstar.com/proxyopen/dataopen/percent_dialog_mode_count' \
     --header 'Authorization: Bearer YOUR-ACCESS-TOKEN' \
     --header 'Content-Type: application/x-www-form-urlencoded' \
     --data-urlencode 'ov_corpid=test_ov_corpid' \
     --data-urlencode 'compare=2024-02-01,2024-02-03'

响应

响应体 data 对象

公共响应体请参考 公共响应 和 响应体通用参数

参数 类型 参数说明
source array 数据列表数组
source[].dataset array 数据列表数组
source[].dataset[].name string 领域
source[].dataset[].num string 数量
source[].dataset[].percent string 占比

响应体示例

{
    "code": 200,
    "msg": "",
    "data": {
        "source": [
            {
                "dataset": [
                    {
                        "name": "日历",
                        "num": "1",
                        "percent": "0.54"
                    },
                    {
                        "name": "其他",
                        "num": "72",
                        "percent": "38.92"
                    },
                    {
                        "name": "导览",
                        "num": "0",
                        "percent": "0.00"
                    },
                    {
                        "name": "娱乐",
                        "num": "2",
                        "percent": "1.08"
                    },
                    {
                        "name": "问答",
                        "num": "26",
                        "percent": "14.05"
                    },
                    {
                        "name": "轻应用",
                        "num": "2",
                        "percent": "1.08"
                    },
                    {
                        "name": "播报PPT",
                        "num": "0",
                        "percent": "0.00"
                    },
                    {
                        "name": "媒体指令",
                        "num": "1",
                        "percent": "0.54"
                    },
                    {
                        "name": "聊天",
                        "num": "55",
                        "percent": "29.73"
                    },
                    {
                        "name": "天气",
                        "num": "1",
                        "percent": "0.54"
                    },
                    {
                        "name": "导航",
                        "num": "0",
                        "percent": "0.00"
                    },
                    {
                        "name": "接待",
                        "num": "1",
                        "percent": "0.54"
                    },
                    {
                        "name": "打开APP",
                        "num": "0",
                        "percent": "0.00"
                    },
                    {
                        "name": "验证码",
                        "num": "1",
                        "percent": "0.54"
                    },
                    {
                        "name": "问路引领",
                        "num": "6",
                        "percent": "3.24"
                    },
                    {
                        "name": "通用指令",
                        "num": "10",
                        "percent": "5.41"
                    },
                    {
                        "name": "注册",
                        "num": "0",
                        "percent": "0.00"
                    }
                ],
                "name": "不同类型交互占比"
            }
        ]
    }
}

● 语音对话明细

请求

请求协议

公共请求协议请参考 公共请求协议

HTTP URL 路径 /proxyopen/dataopen/voice_list

请求头

公共请求头请参考 公共请求头

请求体参数

公共请求体参数请参考 公共请求体参数

请求 cURL 示例

curl --location 'https://openapi.orionstar.com/proxyopen/dataopen/voice_list' \
     --header 'Authorization: Bearer YOUR-ACCESS-TOKEN' \
     --header 'Content-Type: application/x-www-form-urlencoded' \
     --data-urlencode 'ov_corpid=test_ov_corpid' \
     --data-urlencode 'compare=2024-02-01,2024-02-03'

响应

响应体 data 对象

公共响应体请参考 公共响应 和 响应体通用参数

参数 类型 参数说明
list array 数据列表数组
list[].domain string 领域
list[].intent string 意图
list[].question string 对话-问题
list[].answer string 对话-答案
pagination object 分页信息对象
pagination.pageIndex int 当前是第几页
pagination.pageSize int 每页多少条数据
pagination.total int 一共有多少条数据

响应体示例

{
    "code": 200,
    "msg": "",
    "data": {
        "list": [
            {
                "time": "2024-02-01 23:29:29",
                "device": "test_sn",
                "sid": "bb3e6a6d-2cba-4a90-1234-f1d7dc44e214",
                "enterprise": "猎户星空",
                "domain": "其他",
                "intent": "其他",
                "answer": "",
                "question": "充电吧",
                "device_id": "test_sn",
                "enterprise_id": "orion.ovs.entprise.123456",
                "text_domain": "other",
                "text_intent": "other"
            }
        ],
        "pagination": {
            "pageIndex": 1,
            "pageSize": 1,
            "total": 191
        }
    }
}

● 关键词词云汇总

请求

请求协议

公共请求协议请参考 公共请求协议

HTTP URL 路径 /proxyopen/dataopen/entity_words_cloud_open

请求头

公共请求头请参考 公共请求头

请求体参数

公共请求体参数请参考 公共请求体参数

请求 cURL 示例

curl --location 'https://openapi.orionstar.com/proxyopen/dataopen/entity_words_cloud_open' \
     --header 'Authorization: Bearer YOUR-ACCESS-TOKEN' \
     --header 'Content-Type: application/x-www-form-urlencoded' \
     --data-urlencode 'ov_corpid=test_ov_corpid' \
     --data-urlencode 'compare=2024-02-01,2024-02-03'

响应

响应体 data 对象

公共响应体请参考 公共响应 和 响应体通用参数

参数 类型 参数说明
list array 数据列表数组
list[].name string 关键词
list[].value string 次数

响应体示例

{
    "code": 200,
    "msg": "",
    "data": {
        "list": [{
            "name": "餐厅",
            "value": "7"
        }, {
            "name": "好吃的",
            "value": "6"
        }, {
            "name": "音乐",
            "value": "3"
        }]
    }
}

● 不同交互类型占比汇总

请求

请求协议

公共请求协议请参考 公共请求协议

HTTP URL 路径 /proxyopen/dataopen/percent_interaction_mode_count

请求头

公共请求头请参考 公共请求头

请求体参数

公共请求体参数请参考 公共请求体参数

请求 cURL 示例

curl --location 'https://openapi.orionstar.com/proxyopen/dataopen/percent_interaction_mode_count' \
     --header 'Authorization: Bearer YOUR-ACCESS-TOKEN' \
     --header 'Content-Type: application/x-www-form-urlencoded' \
     --data-urlencode 'ov_corpid=test_ov_corpid' \
     --data-urlencode 'compare=2024-02-01,2024-02-03'

响应

响应体 data 对象

公共响应体请参考 公共响应 和 响应体通用参数

参数 类型 参数说明
source array 数据列表数组
source[].dataset array 数据列表数组
source[].dataset[].name string 类型
source[].dataset[].num string 数量
source[].dataset[].percent string 占比

响应体示例

{
    "code": 200,
    "msg": "",
    "data": {
        "source": [
            {
                "dataset": [
                    {
                        "name": "语音交互",
                        "num": "185",
                        "percent": "96.86"
                    },
                    {
                        "name": "触摸交互",
                        "num": "6",
                        "percent": "3.14"
                    }
                ],
                "name": "不同类型交互占比"
            }
        ]
    }
}

● 用户画像占比汇总

请求

请求协议

公共请求协议请参考 公共请求协议

HTTP URL 路径 /proxyopen/dataopen/crowd_analysis_overview

请求头

公共请求头请参考 公共请求头

请求体参数

公共请求体参数请参考 公共请求体参数

参数 类型 必填 参数说明
type string 是 类型。
gender：用户性别分布
age：用户年龄分布
new_old：新老用户分布

请求 cURL 示例

curl --location 'https://openapi.orionstar.com/proxyopen/dataopen/crowd_analysis_overview' \
     --header 'Authorization: Bearer YOUR-ACCESS-TOKEN' \
     --header 'Content-Type: application/x-www-form-urlencoded' \
     --data-urlencode 'ov_corpid=test_ov_corpid' \
     --data-urlencode 'compare=2024-02-01,2024-02-03' \
     --data-urlencode 'type=gender'

响应

响应体 data 对象

公共响应体请参考 公共响应 和 响应体通用参数

参数 类型 参数说明
source array 数据列表数组
source[].dataset array 数据列表数组
source[].dataset[].name string 类型
source[].dataset[].num string 数量

响应体示例

{
    "code": 200
    "msg": "",
    "data": {
        "source": [{
            "name": "性别",
            "dataset": [{
                "name": "男",
                "num": "5"
            }, {
                "name": "女",
                "num": "5"
            }, {
                "name": "未知",
                "num": 0
            }]
        }]
    }
}