概述
更新时间： 2024/02/22 16:15:13
指南针 REST APIs 可以让您通过 HTTP 请求来获取应用运行基本数据。通过调用 API 直接获取指南针的数据，并在自己的业务运营平台中灵活集成使用。
URL
所有 REST APIs 资源使用以下 endpoint URL。
https://data.netease.im
- 请求：请求直接在 URL 中使用查询字符串参数（query String）。
- 响应：响应内容的格式为 JSON。
鉴权
所有对指南针平台 API 的请求都通过 HTTPS 协议执行。HTTPS 请求所需鉴权可联系技术支持提供。
资源
| 类别 | API | 描述 |
|---|---|---|
| RTC 明细类数据 | 查询房间列表 | 根据房间 ID、用户 ID、房间名称等分页查询房间列表。 |
| 查询用户列表 | 根据房间 ID 查询用户进出房信息，包括用户网络类型、平台、版本等基础信息。 | |
| 查询用户通话质量详情 | 按照 cid、uid维度，获取对应指标项的通话质量数据。 | |
| 查询用户互动关系 | 按照 cid、uid，获取当前用户订阅过的用户列表或当前用户被订阅的用户列表。 | |
| 查询房间音视频卡顿率指标 | 按照房间列表查询房间的音视频卡顿率。 | |
| 查询用户音视频卡顿率指标 | 按照房间ID、用户列表查询用户的音视频卡顿率。 | |
| 实时大盘数据 | 查询指标实时多维度分布 | 按照指标维度聚合、获取各个维度值下对应的指标值、采样数。 |
| 查询 Top 20 房间排行 | 按照指标获取 Top 20 的房间，最终根据 Top 20 房间查询其它相关指标。 | |
| 离线大盘质量类数据 | 查询聚合质量指标 | 获取指定时间范围内，指定维度下的聚合质量指标。 |
| 查询时序质量指标 | 获取指定时间范围内天粒度的质量指标。 |
此文档是否对你有帮助？
