文档

DescribeChannelUserMetrics - 查询频道概览中的用户数据

更新时间:

本接口用于查询频道概览中的用户数据。

接口说明

使用说明

本接口用于查询频道概览中的用户数据。例如:您可以查询指标数据详情、概览数据等信息。

QPS 限制

本接口的单用户 QPS 限制为 5 次/秒。超过限制,API 调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见 QPS 限制

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
AppIdstring

APP ID。

testappid
ChannelIdstring

频道 ID。

testid
CreatedTslong

创建频道的时间戳,支持查询最近 30 天的数据。使用 UNIX 时间戳表示,单位:秒。

1614936817
DestroyedTslong

释放频道的时间戳,使用 UNIX 时间戳表示,单位:秒。参数为空表示获取当前时间。

说明 如果传入的频道释放时间超过真实的释放时间,将返回从创建时间开始到真实释放时间之间的数据。
1614936817

返回参数

名称类型描述示例值
object

Schema of Response

MetricDatasobject []

指标数据列表。

Typestring

指标类型。取值:

  • ALL_NUM:单位时间内的用户数量。
  • PUB_NUM:单位时间内发布端的用户数量。
  • SUB_NUM:单位时间内订阅端的用户数量。
  • JOIN_FAIL_NUM:单位时间内加入频道异常的用户数量。
  • BAD_EXP_NUM:单位时间内通信体验异常的用户数量。
ALL_NUM
Nodesobject []

指标趋势图坐标点列表。

Xstring

指标趋势图中 x 轴横坐标。

1612418625
Ystring

指标趋势图中 y 轴纵坐标。

123
Extobject

拓展属性。

OverallDataobject

总览数据。

TotalUserNumlong

累计用户数量。

5
TotalPubUserNumlong

累计发布端用户数量。

1
TotalSubUserNumlong

累计订阅端用户数量。

3
TotalJoinFailNumlong

累计加入频道异常用户数量。

0
TotalBadExpNumlong

累计通信体验异常用户数量。

0
RequestIdstring

请求 ID。

231470C1-ACFB-4C9F-844F-4CFE1E3804C5

示例

正常返回示例

JSON格式

{
  "MetricDatas": [
    {
      "Type": "ALL_NUM",
      "Nodes": [
        {
          "X": "1612418625",
          "Y": "123",
          "Ext": {
            "test": "test",
            "test2": 1
          }
        }
      ]
    }
  ],
  "OverallData": {
    "TotalUserNum": 5,
    "TotalPubUserNum": 1,
    "TotalSubUserNum": 3,
    "TotalJoinFailNum": 0,
    "TotalBadExpNum": 0
  },
  "RequestId": "231470C1-ACFB-4C9F-844F-4CFE1E3804C5"
}

错误码

HTTP status code错误码错误信息描述
400ApiParamErrorAPI %s.Api参数错误
403BizCreatedTsErrorA business CreatedTs error occurred.参数会议创建时间不准确。
403BizAppErrorA business application permission error occurred.业务应用权限错误
403BizUidErrorA business UID error occurred.业务主账号错误
500ServerInternalErrorAn internal error occurred.服务器内部错误

访问错误中心查看更多错误码。