本接口用于獲取端對端用戶事件列表。
接口說明
使用說明
本接口用于獲取端對端用戶事件列表。例如:在事件列表中您可以獲取事件名稱、事件類型等信息。
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 |
UserIdList | string | 是 | 用戶 ID 列表,多個用英文逗號(,)分隔。 | testuserid1,testuserid2 |
返回參數
示例
正常返回示例
JSON
格式
{
"Nodes": [
{
"UserId": "testuserid",
"EventDataItems": [
{
"Ts": 1614936817,
"EventList": [
{
"EventName": "開始發布",
"EventType": "USER",
"Ts": 1614936817,
"TsInMs": "1614936817123"
}
]
}
]
}
],
"RequestId": "231470C1-ACFB-4C9F-844F-4CFE1E3804C5"
}
錯誤碼
HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
---|---|---|---|
400 | ApiParamError | API %s. | Api參數錯誤 |
403 | BizAppError | A business application permission error occurred. | 業務應用權限錯誤 |
403 | BizUidError | A business UID error occurred. | 業務主賬號錯誤 |
500 | ServerInternalError | An internal error occurred. | 服務器內部錯誤 |
訪問錯誤中心查看更多錯誤碼。