API 文档总览

欢迎使用 Verhub API 文档

按模块查看接口说明。每个接口页提供请求参数、响应示例、鉴权方式和在线调试能力，便于联调与排错。

POST创建项目

/api/v1/admin/projects

DELETE删除项目

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

GET列出项目别名

/api/v1/admin/projects/{projectKey}/aliases

DELETE删除项目别名

/api/v1/admin/projects/{projectKey}/aliases/{alias}

GET列出项目注册的语言

/api/v1/admin/projects/{projectKey}/locales

POST注册项目语言

/api/v1/admin/projects/{projectKey}/locales

DELETE注销项目语言

/api/v1/admin/projects/{projectKey}/locales/{locale}

GET查询 GitHub Release Webhook 配置

/api/v1/admin/projects/{projectKey}/github-webhook

PUT设置 GitHub Release Webhook Secret

/api/v1/admin/projects/{projectKey}/github-webhook

DELETE清除 GitHub Release Webhook Secret

/api/v1/admin/projects/{projectKey}/github-webhook

POST重新生成 GitHub Release Webhook Secret

/api/v1/admin/projects/{projectKey}/github-webhook/regenerate

POST接收 GitHub Release Webhook 推送

/api/v1/webhooks/github/{projectKey}

GET查询实例级 GitHub App 配置

/api/v1/admin/github-app

PUT更新实例级 GitHub App 配置

/api/v1/admin/github-app

DELETE清空实例级 GitHub App 配置

/api/v1/admin/github-app

GET查询项目级 GitHub 集成配置

/api/v1/admin/projects/{projectKey}/github-integration

PUT更新项目级 GitHub 集成配置

/api/v1/admin/projects/{projectKey}/github-integration

GET预览仓库中的反馈 Issue 模板

/api/v1/admin/projects/{projectKey}/github-integration/repo-template

POST接收 GitHub App 事件推送

/api/v1/webhooks/github-app

POST创建版本

/api/v1/admin/projects/{projectKey}/versions

PATCH更新版本

/api/v1/admin/projects/{projectKey}/versions/{id}

DELETE删除版本

/api/v1/admin/projects/{projectKey}/versions/{id}

POST新增公告

/api/v1/admin/projects/{projectKey}/announcements

PATCH更新公告

/api/v1/admin/projects/{projectKey}/announcements/{id}

DELETE删除公告

/api/v1/admin/projects/{projectKey}/announcements/{id}

GET查询反馈列表

/api/v1/admin/projects/{projectKey}/feedbacks

POST后台手动新增反馈

/api/v1/admin/projects/{projectKey}/feedbacks

PATCH编辑反馈

/api/v1/admin/projects/{projectKey}/feedbacks/{id}

DELETE删除反馈

/api/v1/admin/projects/{projectKey}/feedbacks/{id}

GET列出条款文档设置

/api/v1/admin/terms/documents

GET查询单份条款文档设置

/api/v1/admin/terms/documents/{slug}

PUT更新条款文档

/api/v1/admin/terms/documents/{slug}

DELETE恢复内置条款正文

/api/v1/admin/terms/documents/{slug}

GET列出条款文档

/api/v1/public/terms

GET获取条款文档正文

/api/v1/public/terms/{slug}

GET查询实例级 AI 翻译配置

/api/v1/admin/translation

PUT更新实例级 AI 翻译配置

/api/v1/admin/translation

DELETE清空实例级 AI 翻译配置

/api/v1/admin/translation

POST测试 AI 翻译配置

/api/v1/admin/translation/test

POSTAI 翻译内容

/api/v1/admin/projects/{projectKey}/translate

GET获取项目公开信息

/api/v1/public/{projectKey}

GET获取公开版本列表

/api/v1/public/{projectKey}/versions

GET获取最新公开版本

/api/v1/public/{projectKey}/versions/latest

GET获取最新 preview 版本

/api/v1/public/{projectKey}/versions/latest-preview

GET按版本号获取指定版本信息

/api/v1/public/{projectKey}/versions/by-version/{version}

POST提交当前版本并检查更新

/api/v1/public/{projectKey}/versions/check-update

GET获取公开公告列表

/api/v1/public/{projectKey}/announcements

GET获取最新公告

/api/v1/public/{projectKey}/announcements/latest

POST提交用户反馈

/api/v1/public/{projectKey}/feedbacks

GET查询反馈提交选项

/api/v1/public/{projectKey}/feedbacks/options

GET查询接口请求统计概览

/api/v1/admin/projects/{projectKey}/stats/requests/overview

GET查询接口请求时间序列

/api/v1/admin/projects/{projectKey}/stats/requests/timeseries

GET查询版本采纳曲线

/api/v1/admin/projects/{projectKey}/stats/requests/version-adoption

GET查询日志等级分布

/api/v1/admin/projects/{projectKey}/stats/logs

GET查询反馈评分分布

/api/v1/admin/projects/{projectKey}/stats/feedbacks

GET查询客户端版本分布

/api/v1/admin/projects/{projectKey}/stats/requests/client-versions

GET查询客户端系统版本分布

/api/v1/admin/projects/{projectKey}/stats/requests/platform-versions

GET查询请求活跃度热力图

/api/v1/admin/projects/{projectKey}/stats/requests/heatmap

GET查询日志列表

/api/v1/admin/projects/{projectKey}/logs

POST后台手动新增日志

/api/v1/admin/projects/{projectKey}/logs

PATCH更新日志可见性

/api/v1/admin/projects/{projectKey}/logs/{logId}

POST上报日志

/api/v1/public/{projectKey}/logs

POST批量上报事件

/api/v1/public/{projectKey}/events

GET导出本人的事件数据

/api/v1/public/{projectKey}/events/me

DELETE删除本人的事件数据

/api/v1/public/{projectKey}/events/me

GET查询事件定义

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

PATCH编辑事件定义

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

DELETE删除事件定义

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

GET事件概览

/api/v1/admin/projects/{projectKey}/events/stats/overview

GET事件量趋势

/api/v1/admin/projects/{projectKey}/events/stats/timeseries

GET事件分布

/api/v1/admin/projects/{projectKey}/events/stats/breakdown

GET事件活跃热力图

/api/v1/admin/projects/{projectKey}/events/stats/heatmap

POST漏斗转化分析

/api/v1/admin/projects/{projectKey}/events/analysis/funnel

POST留存分析

/api/v1/admin/projects/{projectKey}/events/analysis/retention

POST路径分析

/api/v1/admin/projects/{projectKey}/events/analysis/paths

POST指标 DSL 求值

/api/v1/admin/projects/{projectKey}/events/analysis/query

GET查询看板卡片

/api/v1/admin/projects/{projectKey}/events/dashboards/cards

POST创建看板卡片

/api/v1/admin/projects/{projectKey}/events/dashboards/cards

PATCH编辑看板卡片

/api/v1/admin/projects/{projectKey}/events/dashboards/cards/{cardId}

DELETE删除看板卡片

/api/v1/admin/projects/{projectKey}/events/dashboards/cards/{cardId}

DELETE代最终用户删除事件数据

/api/v1/admin/projects/{projectKey}/events/subjects/{distinctId}