GET管理接口

查询事件定义

列出该项目已出现过的事件。定义由采集端自动发现,**没有对应的创建接口**—— 客户端上报什么事件名,这里就会出现什么。`range_count` 是查询区间内的上报量, 供选择器把常用事件排在前面。

URL

/api/v1/admin/projects/{projectKey}/events/definitions

鉴权方式

需要管理员 JWT 或 API Key,二者等价(Authorization: Bearer <token>)

请求参数

Path 参数

名称类型必填说明
projectKeystring项目主键 project_key(大小写不敏感)

Query 参数

名称类型必填说明
start_timeintegerUnix 时间戳(秒)
end_timeintegerUnix 时间戳(秒)
limitinteger分页大小
offsetinteger分页偏移
searchstring关键字,不区分大小写地匹配事件名、显示名与描述。
include_archivedboolean是否包含已归档的事件。

Header 参数

名称类型必填说明
AuthorizationstringBearer <管理员 JWT 或 API Key>

该接口无需请求体。

响应示例

200 响应

{
  "total": 0,
  "data": [
    {
      "event_definition_id": "clx7f2k9v0000abcd",
      "project_key": "demo",
      "name": "checkout_clicked",
      "display_name": "点击结算",
      "description": "用户在购物车页点击结算按钮",
      "archived": false,
      "first_seen_time": 1759000000,
      "last_seen_time": 1760000000,
      "range_count": 1284
    }
  ]
}
GET

Try It Out

请求 URL 预览

/api/v1/admin/projects/verhub/events/definitions?start_time=1760000000&end_time=1762000000&limit=20&offset=0&search=checkout&include_archived=false