API
常用端点
API 为应用中的所有操作提供端点，但大多数集成只会使用少量读取端点，也就是网站概览页面所依赖的端点。本页面列出了这些端点的快捷入口。每一行都链接到包含参数和响应的完整参考页面。
以下路径均相对于您的 API 基础 URL：自托管时为 http://<your-umami-instance>/api，或使用 API 密钥获取的 Umami Cloud 基础 URL。
查找网站#
大多数统计端点都需要 websiteId。
| 操作 | 端点 | 详情 |
|---|---|---|
| 列出所有可访问的网站 | GET /api/websites | 列出网站 |
| 获取单个网站 | GET /api/websites/{websiteId} | 获取网站 |
概览数字#
仪表板顶部的统计卡片和活跃访客数。
| 操作 | 端点 | 详情 |
|---|---|---|
| 页面浏览量、访客数、访问次数、跳出次数、总时长（含比较数据） | GET /api/websites/{websiteId}/stats | 获取网站摘要统计 |
| 最近 5 分钟内活跃的访客 | GET /api/websites/{websiteId}/active | 获取活跃网站访客 |
随时间变化的图表#
| 操作 | 端点 | 详情 |
|---|---|---|
| 页面浏览量和会话时间序列 | GET /api/websites/{websiteId}/pageviews | 获取页面浏览量和会话随时间的变化 |
| 事件时间序列 | GET /api/websites/{websiteId}/events/series | 获取自定义事件随时间的数量 |
明细#
按单个维度排序的列表，例如热门页面、引荐来源、浏览器、国家/地区和事件等。通过 type 传入维度（path、referrer、browser、os、device、country、event 等）。
| 操作 | 端点 | 详情 |
|---|---|---|
| 单个维度的排序列表 | GET /api/websites/{websiteId}/metrics?type=path | 获取网站排序指标 |
| 同一列表，并显示每行的页面浏览量、访客数、访问次数、跳出次数和时长 | GET /api/websites/{websiteId}/metrics/expanded?type=path | 获取详细网站指标 |
实时数据#
| 操作 | 端点 | 详情 |
|---|---|---|
| 实时国家/地区、URL、引荐来源、事件和总数（最近 30 分钟） | GET /api/realtime/{websiteId} | 获取网站实时活动 |
示例#
获取一个网站 24 小时范围内的摘要统计。
1. 认证。 在自托管 Umami 上，用您的凭据换取令牌：
在下面的每个请求中通过 Authorization: Bearer <token> 发送该令牌。在 Umami Cloud 上跳过此步骤，并以相同方式传入您的 API 密钥：Authorization: Bearer <api-key>。请参阅认证。
2. 查找网站 ID。
3. 获取概览统计。 startAt 和 endAt 是定义时间范围的毫秒级 Unix 时间戳，下面的示例值覆盖 24 小时：