Umami API

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

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
  }
}

事件

• GET /event-data/values：查询参数 eventName 已改为 event。

报告

• POST /reports：insights 报告已改为 breakdown。

2024-09-09

网站

• GET /websites/[id]/pageviews：修正了 region 参数为可选。
• GET /websites/[id]/events：更改结果集为指定时间范围内的网站事件详情。
• GET /websites/[id]/events/series：新增 事件指标端点（之前使用 GET /websites/[id]/events）。

事件数据

• GET /event-data/events ：迁移至 /websites/[id]/event-data/events。
• GET /event-data/fields ：迁移至 /websites/[id]/event-data/fields。
• GET /event-data/stats ：迁移至 /websites/[id]/event-data/stats。
• GET /websites/[id]/event-data/values ：新增

会话

• GET /websites/:websiteId/sessions ：新增
• GET /websites/:websiteId/sessions/stats ：新增
• GET /websites/:websiteId/sessions/:sessionId ：新增
• GET /websites/:websiteId/sessions/:sessionId/activity ：新增
• GET /websites/:websiteId/sessions/:sessionId/properties ：新增
• GET /websites/:websiteId/session-data/properties ：新增
• GET /websites/:websiteId/session-data/values ：新增

2024-05-23

网站

• GET /websites/[id]/stats：将 change 重命名为 prev。

2024-03-27

网站

• GET /websites/[id]/stats：将 uniques 重命名为 visitors。新增 visits。

2024-02-16

网站

• POST /websites：新增可选参数 teamId。

团队

• /teams/[id]/websites/[websiteId]：已废弃
• GET /teams/[id]/users/[userId]/index：新增

报告

• GET /reports/index：新增查询参数 websiteId 和 teamId。