文档

DescribeChannelAreaDistributionStatData - 获取频道地区分布统计数据

更新时间:

本接口用于获取频道地区分布统计数据。

接口说明

使用说明

本接口用于获取频道地区分布统计数据。

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
ParentAreastring

父级地区名称,例如:深圳市的父级为广东省。参数为空表示世界范围(国家维度)的统计,例如:中国、英国。

中国_浙江省

返回参数

名称类型描述示例值
object
AreaStatListobject []

地域统计列表。

AreaNamestring

地域名称,例如:中国_浙江省_杭州市。

中国_浙江省_杭州市
CallUserCountinteger

通信人数。

1
PubUserCountinteger

发布端人数。

1
SubUserCountinteger

订阅端人数。

1
HighQualityTransmissionRatestring

优质传输率,用小数表示,例如 0.9999 表示优质传输率为 99.99%。

0.9999
RequestIdstring

请求 ID。

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

示例

正常返回示例

JSON格式

{
  "AreaStatList": [
    {
      "AreaName": "中国_浙江省_杭州市",
      "CallUserCount": 1,
      "PubUserCount": 1,
      "SubUserCount": 1,
      "HighQualityTransmissionRate": "0.9999"
    }
  ],
  "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.服务器内部错误

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