調用DescribeChannelAreaDistributionStatData獲取頻道地區分布統計數據。

使用說明

本接口用于獲取頻道地區分布統計數據。

QPS限制

本接口的單用戶QPS限制為10次/秒。超過限制，API調用會被限流，這可能會影響您的業務，請合理調用。更多信息，請參見QPS限制。

調試

您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。

請求頭

該接口使用公共請求頭，無特殊請求頭。請參見公共請求參數文檔。

請求語法

POST /api/channel/describeChannelAreaDistributionStatData HTTP/1.1

請求參數

名稱 類型 位置 是否必選 示例值 描述
AppId String Query 是 pdtk****

App ID，可通過控制臺創建和查詢。
ChannelId String Query 是 12345

頻道ID。
CreatedTs Long Query 是 1616125296

頻道創建時間，支持查詢最近30天的數據。使用UNIX時間戳表示，單位：秒。
DestroyedTs Long Query 否 1616125993

頻道釋放時間，使用UNIX時間戳表示，單位：秒。參數為空表示獲取當前時間。

說明 如果傳入的頻道釋放時間超過真實的釋放時間，將返回從創建時間開始到真實釋放時間之間的數據。
ParentArea String Query 否 中國_浙江省

父級地區名稱，例如：杭州市的父級為浙江省，參數設為中國_浙江省。參數為空表示世界范圍（國家維度）的統計，例如：中國、英國。

返回數據

名稱 類型 示例值 描述
AreaStatList Array of AreaStatData

地域統計列表。
AreaName String 中國_浙江省_杭州市

地域名稱，例如：中國_浙江省_杭州市。
CallUserCount Integer 3

通信人數。
PubUserCount Integer 2

發布端人數。
SubUserCount Integer 1

訂閱端人數。
HighQualityTransmissionRate String 0.9999

優質傳輸率，用小數表示，例如0.9999表示優質傳輸率為99.99%。
RequestId String 659D0AE5-B9EC-4878-B297-A2444C9E64D7

請求ID。

示例

請求示例

POST api/channel/describeChannelAreaDistributionStatData?AppId=pdtk****&ChannelId=12345&CreatedTs=1616125296&DestroyedTs=1616125993&ParentArea=中國_浙江省 HTTP/1.1
Host: vdc.cn-shenzhen.aliyuncs.com 
Date: GMT Date

正常返回示例

XML格式 

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeChannelAreaDistributionStatDataResponse>
<requestId>659D0AE5-B9EC-4878-B297-A2444C9E64D7</requestId>
<code>200</code>
<message/>
<action/>
<apiName/>
<extendedCode/>
<bizCode/>
<httpStatusCode>200</httpStatusCode>
<data>
    <RequestId>659D0AE5-B9EC-4878-B297-A2444C9E64D7</RequestId>
    <AreaStatList>
        <AreaName>中國_浙江省_杭州市</AreaName>
        <CallUserCount>3</CallUserCount>
        <HighQualityTransmissionRate>98.87</HighQualityTransmissionRate>
        <SubUserCount>1</SubUserCount>
        <PubUserCount>2</PubUserCount>
    </AreaStatList>
</data>
<successResponse>true</successResponse>
</DescribeChannelAreaDistributionStatDataResponse>

JSON格式 

HTTP/1.1 200 OK
Content-Type:application/json

{
  "requestId" : "659D0AE5-B9EC-4878-B297-A2444C9E64D7",
  "code" : "200",
  "httpStatusCode" : "200",
  "data" : {
    "RequestId" : "659D0AE5-B9EC-4878-B297-A2444C9E64D7",
    "AreaStatList" : [ {
      "AreaName" : "中國_浙江省_杭州市",
      "CallUserCount" : 3,
      "HighQualityTransmissionRate" : "98.87",
      "SubUserCount" : 1,
      "PubUserCount" : 2
    } ]
  },
  "successResponse" : true
}