調(diào)用DescribeChannelDistributionStatData獲取頻道分布統(tǒng)計(jì)數(shù)據(jù)。

使用說明

本接口用于獲取頻道分布統(tǒng)計(jì)數(shù)據(jù)。您可以按系統(tǒng)類型或SDK版本不同維度統(tǒng)計(jì)數(shù)據(jù)。

QPS限制

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

調(diào)試

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

請求頭

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

請求語法

POST /api/channel/describeChannelDistributionStatData HTTP/1.1

請求參數(shù)

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

App ID，可通過控制臺創(chuàng)建和查詢。
ChannelId String Query 是 123333

頻道ID。
CreatedTs Long Query 是 1615893133

創(chuàng)建頻道的時(shí)間戳，支持查詢最近30天的數(shù)據(jù)。使用UNIX時(shí)間戳表示，單位：秒。
DestroyedTs Long Query 否 1615893757

釋放頻道的時(shí)間戳，使用UNIX時(shí)間戳表示，單位：秒。參數(shù)為空表示獲取當(dāng)前時(shí)間。

說明 如果傳入的頻道釋放時(shí)間超過真實(shí)的釋放時(shí)間，將返回從創(chuàng)建時(shí)間開始到真實(shí)釋放時(shí)間之間的數(shù)據(jù)。
StatDim String Query 是 OS

統(tǒng)計(jì)維度，取值：

  • OS：按照系統(tǒng)統(tǒng)計(jì)。
  • SDK_VERSION：按照SDK版本統(tǒng)計(jì)。

返回?cái)?shù)據(jù)

名稱 類型 示例值 描述
StatList Array of StatData

頻道分布統(tǒng)計(jì)列表。
Name String macOS

統(tǒng)計(jì)維度。
CallUserCount Integer 1

通信人數(shù)。
CallUserRatio String 1.0000

通信人數(shù)占比，用小數(shù)表示，例如1.0000表示通信人數(shù)占比為100%。
RequestId String 4EBB875A-C25F-49DE-8567-F4E226B4AB9D

請求ID。

示例

請求示例

POST api/channel/describeChannelDistributionStatData?AppId=9qb1****&ChannelId=123333&CreatedTs=1615893133&DestroyedTs=1615893757&StatDim=OS HTTP/1.1
Host: vdc.cn-shenzhen.aliyuncs.com 
Date: GMT Date

正常返回示例

XML格式 

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

<DescribeChannelDistributionStatDataResponse>
<code>200</code>
<data>
    <StatList>
        <CallUserRatio>0.25</CallUserRatio>
        <CallUserCount>1</CallUserCount>
        <Name>macOS</Name>
    </StatList>
    <StatList>
        <CallUserRatio>0.75</CallUserRatio>
        <CallUserCount>3</CallUserCount>
        <Name>Linux</Name>
    </StatList>
    <RequestId>4EBB875A-C25F-49DE-8567-F4E226B4AB9D</RequestId>
</data>
<httpStatusCode>200</httpStatusCode>
<requestId>4EBB875A-C25F-49DE-8567-F4E226B4AB9D</requestId>
<successResponse>true</successResponse>
</DescribeChannelDistributionStatDataResponse>

JSON格式 

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

{
  "code" : "200",
  "data" : {
    "StatList" : [ {
      "CallUserRatio" : "0.25",
      "CallUserCount" : 1,
      "Name" : "macOS"
    }, {
      "CallUserRatio" : "0.75",
      "CallUserCount" : 3,
      "Name" : "Linux"
    } ],
    "RequestId" : "4EBB875A-C25F-49DE-8567-F4E226B4AB9D"
  },
  "httpStatusCode" : "200",
  "requestId" : "4EBB875A-C25F-49DE-8567-F4E226B4AB9D",
  "successResponse" : true
}