API 使用与调试#

Umami 提供 REST API 用于获取统计数据。

API 认证#

API 请求需要通过 Header 传递 API Key：

1
x-umami-api-key: <your-api-key>

常用 API 端点#

端点	说明
`GET /api/websites`	获取所有网站列表
`GET /api/websites/:websiteId/stats`	获取网站统计数据
`GET /api/websites/:websiteId/pageviews`	获取页面浏览量
`GET /api/websites/:websiteId/events`	获取事件数据

使用 curl 测试 API#

Windows CMD#

1
curl "https://api.umami.is/v1/websites/:websiteId/stats?startAt=0&endAt=1780329600000" -H "Accept: application/json" -H "x-umami-api-key: <api-key>"

Linux / macOS#

1
curl "https://api.umami.is/v1/websites/:websiteId/stats?startAt=0&endAt=1780329600000" \
2
  -H "Accept: application/json" \
3
  -H "x-umami-api-key: <api-key>"