Umami API

此页面记录了对 api.umami.is 所做的更改。

2026-03-11

网站

GET /api/websites/:websiteId/daterange: 新增 — 返回某网站所收集数据的最早和最晚日期范围。

事件

GET /api/websites/:websiteId/events/stats: 新增 — 返回事件统计信息，可选支持按前后期间进行比较。

链接

POST /api/links: 新增 — 创建一个链接。

像素

POST /api/pixels: 新增 — 创建一个像素。

报告

POST /api/reports/goal: 已从 POST /api/reports/goals 重命名（单数路径）。
POST /api/reports/performance: 新增 — 支持 LCP、INP、CLS、FCP 和 TTFB 指标的性能报告类型。
POST /api/reports/revenue: 新增 compare 参数。响应现在在 total 对象中包含 arpu 和 comparison，并新增 region、referrer 和 channel 分解数组。

2026-03-02

事件

GET /api/websites/:websiteId/event-data: 新增

2026-02-04

新增了 share API 文档这里。

2025-11-13

实时

GET /api/realtime/:websiteId：移除了 timezone 参数。响应将在所有数据集中始终以 UTC 返回。

2025-10-07

过滤器

过滤器 url 改为 path。
过滤器 host 改为 hostname。

网站

GET /websites/[id]/metrics：type 参数中的 url 改为 path。
GET /websites/[id]/stats：响应数据结构已更改。

{
  "pageviews": 34210,
  "visitors": 9401,
  "visits": 12726,
  "bounces": 7918,
  "totaltime": 5214477,
  "comparison": {
    "pageviews": 30818,
    "visitors": 8776,
    "visits": 11756,
    "bounces": 7396,
    "totaltime": 1704355
  }
}