事件

如何拉取特定录制的所有事件。

事件

检索事件

Section titled 检索事件

返回在特定会话中捕获的事件列表（点击、页面访问、输入、自定义事件等）。会话范围由服务器强制限定——sessionID 路径参数会自动添加为事件过滤器。

方法

Section titled 方法

POST

URL

Section titled URL

/public/:projectKey/sessions/:sessionId/events

参数

Section titled 参数
名称类型描述
projectKeystring项目密钥（必填）
sessionIdstring会话的 ID（必填，最大 256）

请求体

Section titled 请求体
名称类型描述
startTimestampepoch (ms)时间窗口的起点（必填，最小 946684800000）
endTimestampepoch (ms)时间窗口的终点（必填，> startTimestamp）
limitinteger每页大小，1-200（必填）
pageinteger页码，从 1 开始（必填）
sortBystring用于排序的事件列（可选）
sortOrderstringasc 或 desc（可选）
filtersarray额外的事件过滤器（可选）——参见下方的过滤器结构
columnsarray要包含在响应中的事件列（可选）

过滤器对象：

名称类型描述
namestring过滤器属性名称（必填，最大 256）
operatorstring比较运算符（例如 is、contains）
valuestring[]最多 10 个值，每个最大 256 个字符
isEventboolean过滤器是否针对事件属性
dataTypestringstring、number、boolean、integer、timestamp 之一

请求头

Section titled 请求头

Authorization: Bearer {YOUR_ORGANIZATION_API_KEY}

状态码

Section titled 状态码

200 响应以 JSON 形式发送在正文中
400 正文无效或 sessionID 无效（为空或 > 256 个字符）

请求示例

Section titled 请求示例
curl -X POST \
  {BASE_URL}/public/3sWXSsqHgSKnE87YkNJK/sessions/4813023023591169/events \
  -H 'content-type: application/json' \
  -H 'Authorization: Bearer {YOUR_ORGANIZATION_API_KEY}' \
  --data-raw '{
    "startTimestamp": 1623440000000,
    "endTimestamp":   1623441000000,
    "limit": 100,
    "page":  1,
    "sortOrder": "asc"
  }'

响应示例

Section titled 响应示例
{
  "data": {
    "total": 3,
    "events": [
      {
        "event_id": "01H7Z...",
        "$event_name": "$pageview",
        "created_at": 1623440905732,
        "distinct_id": "mickael@openreplay.com",
        "session_id": "4813023023591169",
        "properties": { "path": "/my-account/" }
      },
      {
        "event_id": "01H7Z...",
        "$event_name": "$click",
        "created_at": 1623440915126,
        "distinct_id": "mickael@openreplay.com",
        "session_id": "4813023023591169",
        "$properties": { "label": "Shop" },
        "$auto_captured": true
      }
    ]
  }
}