調用DescribeChannelUserMetrics查詢頻道概覽中的用戶數據。

使用說明

本接口用于查詢頻道概覽中的用戶數據。例如：您可以查詢指標數據詳情、概覽數據等信息。

QPS限制

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

調試

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

請求頭

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

請求語法

POST /api/channel/describeChannelUserMetrics HTTP/1.1

請求參數

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

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

頻道ID。
CreatedTs Long Query 是 1615893133

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

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

說明 如果傳入的頻道釋放時間超過真實的釋放時間，將返回從創建時間開始到真實釋放時間之間的數據。

返回數據

名稱 類型 示例值 描述
MetricDatas Array of MetricDatas

指標數據列表。
Type String ALL_NUM

指標類型，取值：

  • ALL_NUM：單位時間內的用戶數量。
  • PUB_NUM：單位時間內發布端的用戶數量。
  • SUB_NUM：單位時間內訂閱端的用戶數量。
  • JOIN_FAIL_NUM：單位時間內加入頻道異常的用戶數量。
  • BAD_EXP_NUM：單位時間內通信體驗異常的用戶數量。
Nodes Array of Nodes

指標趨勢圖坐標點列表。
X String 1612418625

指標趨勢圖中x軸橫坐標。
Y String 123

指標趨勢圖中y軸縱坐標。
Ext Map

拓展屬性。
OverallData Object

概覽數據。
TotalUserNum Long 4

累計用戶數量。
TotalPubUserNum Long 4

累計發布端用戶數量。
TotalSubUserNum Long 1

累計訂閱端用戶數量。
TotalJoinFailNum Long 0

累計加入頻道異常用戶數量。
TotalBadExpNum Long 0

累計通信體驗異常用戶數量。
RequestId String F10D39C3-B58B-4A74-89B5-34162BA121E7

請求ID。

示例

請求示例

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

正常返回示例

XML格式 

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

<DescribeChannelUserMetricsResponse>
<code>200</code>
<data>
    <RequestId>F10D39C3-B58B-4A74-89B5-34162BA121E7</RequestId>
    <OverallData>
        <TotalBadExpNum>0</TotalBadExpNum>
        <TotalPubUserNum>4</TotalPubUserNum>
        <TotalJoinFailNum>0</TotalJoinFailNum>
        <TotalUserNum>4</TotalUserNum>
        <TotalSubUserNum>1</TotalSubUserNum>
    </OverallData>
    <MetricDatas>
        <Type>ALL_NUM</Type>
        <Nodes>
            <X>1615893133</X>
            <Y>1</Y>
        </Nodes>
        <Nodes>
            <X>1615893139</X>
            <Y>2</Y>
        </Nodes>
        <Nodes>
            <X>1615893757</X>
        </Nodes>
    </MetricDatas>
    <MetricDatas>
        <Type>JOIN_FAIL_NUM</Type>
        <Nodes>
            <X>1615893133</X>
            <Y>0</Y>
        </Nodes>
        <Nodes>
            <X>1615893289</X>
            <Y>0</Y>
        </Nodes>
        <Nodes>
            <X>1615893601</X>
            <Y>0</Y>
        </Nodes>
        <Nodes>
            <X>1615893757</X>
            <Y>0</Y>
        </Nodes>
    </MetricDatas>
</data>
<httpStatusCode>200</httpStatusCode>
<requestId>F10D39C3-B58B-4A74-89B5-34162BA121E7</requestId>
<successResponse>true</successResponse>
</DescribeChannelUserMetricsResponse>

JSON格式 

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

{
  "code" : "200",
  "data" : {
    "RequestId" : "F10D39C3-B58B-4A74-89B5-34162BA121E7",
    "OverallData" : {
      "TotalBadExpNum" : 0,
      "TotalPubUserNum" : 4,
      "TotalJoinFailNum" : 0,
      "TotalUserNum" : 4,
      "TotalSubUserNum" : 1
    },
    "MetricDatas" : [ {
      "Type" : "ALL_NUM",
      "Nodes" : [ {
        "X" : "1615893133",
        "Y" : "1"
      }, {
        "X" : "1615893139",
        "Y" : "2"
      }, {
        "X" : "1615893757"
      } ]
    }, {
      "Type" : "JOIN_FAIL_NUM",
      "Nodes" : [ {
        "X" : "1615893133",
        "Y" : "0"
      }, {
        "X" : "1615893289",
        "Y" : "0"
      }, {
        "X" : "1615893601",
        "Y" : "0"
      }, {
        "X" : "1615893757",
        "Y" : "0"
      } ]
    } ]
  },
  "httpStatusCode" : "200",
  "requestId" : "F10D39C3-B58B-4A74-89B5-34162BA121E7",
  "successResponse" : true
}