文档

DescribeEndPointEventList - 获取端对端用户事件列表

更新时间:

本接口用于获取端对端用户事件列表。

接口说明

使用说明

本接口用于获取端对端用户事件列表。例如:在事件列表中您可以获取事件名称、事件类型等信息。

QPS 限制

本接口的单用户 QPS 限制为 5 次/秒。超过限制,API 调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见 QPS 限制

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
AppIdstring

APP ID。

testappid
ChannelIdstring

频道 ID。

testid
CreatedTslong

事件查询时间区间的开始时间,该时间不得早于频道实际的创建时间,不得早于 30 天之前。使用 UNIX 时间戳表示,单位:秒。

1614936817
DestroyedTslong

事件查询时间区间的结束时间,该时间不得晚于频道释放时间。使用 UNIX 时间戳表示,单位:秒。参数为空,表示获取当前时间。

1614936817
UserIdListstring

用户 ID 列表,多个用英文逗号(,)分隔。

testuserid1,testuserid2

返回参数

名称类型描述示例值
object
Nodesobject []

用户基本信息列表。

UserIdstring

用户 ID。

testuserid
EventDataItemsobject []

事件数据列表。

Tslong

第一个事件发生的时间,使用 UNIX 时间戳表示,单位:秒。

1614936817
EventListobject []

事件列表。

EventNamestring

事件名称。

开始发布
EventTypestring

事件类型。取值:

  • USER:用户事件。
  • SYSTEM:系统事件。
USER
Tslong

事件发生的时间,使用 UNIX 时间戳表示,单位:秒。

1614936817
TsInMsstring

事件发生的时间,使用 UNIX 时间戳表示,单位:毫秒。

1614936817123
RequestIdstring

请求 ID。

231470C1-ACFB-4C9F-844F-4CFE1E3804C5

示例

正常返回示例

JSON格式

{
  "Nodes": [
    {
      "UserId": "testuserid",
      "EventDataItems": [
        {
          "Ts": 1614936817,
          "EventList": [
            {
              "EventName": "开始发布",
              "EventType": "USER",
              "Ts": 1614936817,
              "TsInMs": "1614936817123"
            }
          ]
        }
      ]
    }
  ],
  "RequestId": "231470C1-ACFB-4C9F-844F-4CFE1E3804C5"
}

错误码

HTTP status code错误码错误信息描述
400ApiParamErrorAPI %s.Api参数错误
403BizAppErrorA business application permission error occurred.业务应用权限错误
403BizUidErrorA business UID error occurred.业务主账号错误
500ServerInternalErrorAn internal error occurred.服务器内部错误

访问错误中心查看更多错误码。