本接口用于查詢頻道概覽中的用戶數據。
接口說明
使用說明
本接口用于查詢頻道概覽中的用戶數據。例如:您可以查詢指標數據詳情、概覽數據等信息。
QPS 限制
本接口的單用戶 QPS 限制為 5 次/秒。超過限制,API 調用會被限流,這可能會影響您的業務,請合理調用。更多信息,請參見 QPS 限制。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
當前API暫無授權信息透出。
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
AppId | string | 是 | APP ID。 | testappid |
ChannelId | string | 是 | 頻道 ID。 | testid |
CreatedTs | long | 是 | 創建頻道的時間戳,支持查詢最近 30 天的數據。使用 UNIX 時間戳表示,單位:秒。 | 1614936817 |
DestroyedTs | long | 否 | 釋放頻道的時間戳,使用 UNIX 時間戳表示,單位:秒。參數為空表示獲取當前時間。 說明
如果傳入的頻道釋放時間超過真實的釋放時間,將返回從創建時間開始到真實釋放時間之間的數據。
| 1614936817 |
返回參數
示例
正常返回示例
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 | 錯誤碼 | 錯誤信息 | 描述 |
---|---|---|---|
400 | ApiParamError | API %s. | Api參數錯誤 |
403 | BizCreatedTsError | A business CreatedTs error occurred. | 參數會議創建時間不準確。 |
403 | BizAppError | A business application permission error occurred. | 業務應用權限錯誤 |
403 | BizUidError | A business UID error occurred. | 業務主賬號錯誤 |
500 | ServerInternalError | An internal error occurred. | 服務器內部錯誤 |
訪問錯誤中心查看更多錯誤碼。