PATCH管理接口

编辑事件定义

补充显示名与描述,或把停用的事件归档。事件名本身不可改——它是客户端上报时使用的键。

URL

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

鉴权方式

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

请求参数

Path 参数

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

Header 参数

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

请求体

{
  "display_name": "string",
  "description": "string",
  "archived": false
}

响应示例

200 响应

{
  "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
}
PATCH

Try It Out

请求 URL 预览

/api/v1/admin/projects/verhub/events/definitions/{definitionId}