GET /api/websites/:websiteId/active
GET /api/websites/:websiteId/events
GET /api/websites/:websiteId/pageviews
GET /api/websites/:websiteId/metrics
GET /api/websites/:websiteId/stats

单位参数

单位参数将返回的数据分组。如果超过最大值，单位会自动转换为下一个更大的适用时间单位。

minute: 最多 60 分钟。
hour: 最多 48 小时。
day: 最多 12 个月。
month: 无限制。
year: 无限制。

GET /api/websites/:websiteId/active

获取网站上活跃用户的数量。

参数

无

示例响应

从网址获取：https://umami.mydomain.com/api/websites/86d4095c-a2a8-4fc8-9521-103e858e2b41/active

{
  "x": 5
}

x: 在过去 5 分钟内的唯一访客数量

GET /api/websites/:websiteId/events/series

获取给定时间范围内的事件。

参数

startAt: 起始日期的时间戳（以毫秒为单位）。
endAt: 结束日期的时间戳（以毫秒为单位）。
unit: 时间单位（year | month | hour | day）。
timezone: 时区（例如，美国/洛杉矶）。
url: （可选）网址名称。
referrer: （可选）引用来源名称。
title: （可选）页面标题名称。
host: （可选）主机名名称。
os: （可选）操作系统名称。
browser: （可选）浏览器名称。
device: （可选）设备名称（例如，移动设备）。
country: （可选）国家名称。
region: （可选）地区/省/州名称。
city: （可选）城市名称。

示例响应

网址：https://umami.mydomain.com/api/websites/86d4095c-a2a8-4fc8-9521-103e858e2b41/events/series?startAt=1683262800000&endAt=1683349199999&unit=hour&timezone=America%2FLos_Angeles

[
  { "x": "live-demo-button", "t": "2023-04-12T22:00:00Z", "y": 1 },
  { "x": "get-started-button", "t": "2023-04-12T22:00:00Z", "y": 5 },
  { "x": "get-started-button", "t": "2023-04-12T23:00:00Z", "y": 4 },
  { "x": "live-demo-button", "t": "2023-04-12T23:00:00Z", "y": 4 },
  { "x": "social-Discord", "t": "2023-04-13T00:00:00Z", "y": 1 }
]

x: 事件名称。
t: 时间戳。
y: 事件数量。

GET /api/websites/:websiteId/pageviews

获取给定时间范围内的页面浏览量。

参数

startAt: 起始日期的时间戳（以毫秒为单位）。
endAt: 结束日期的时间戳（以毫秒为单位）。
unit: 时间单位（year | month | hour | day）。
timezone: 时区（例如，美国/洛杉矶）。
url: （可选）网址名称。
referrer: （可选）引用来源名称。
title: （可选）页面标题名称。
host: （可选）主机名名称。
os: （可选）操作系统名称。
browser: （可选）浏览器名称。
device: （可选）设备名称（例如，移动设备）。
country: （可选）国家名称。
region: （可选）地区/省/州名称。
city: （可选）城市名称。

示例响应

{
  "pageviews": [
    { "x": "2020-04-20 01:00:00", "y": 3 },
    { "x": "2020-04-20 02:00:00", "y": 7 }
  ],
  "sessions": [
    { "x": "2020-04-20 01:00:00", "y": 2 },
    { "x": "2020-04-20 02:00:00", "y": 4 }
  ]
}

x: 时间戳。
y: 访客数量。

GET /api/websites/:websiteId/stats

获取总结的网站统计信息。

参数

startAt: 起始日期的时间戳（以毫秒为单位）。
endAt: 结束日期的时间戳（以毫秒为单位）。
url: （可选）网址名称。
referrer: （可选）引用来源名称。
title: （可选）页面标题名称。
query: （可选）查询名称。
event: （可选）事件名称。
host: （可选）主机名名称。
os: （可选）操作系统名称。
browser: （可选）浏览器名称。
device: （可选）设备名称（例如，移动设备）。
country: （可选）国家名称。
region: （可选）地区/省/州名称。
city: （可选）城市名称。

示例响应

网址：https://umami.mydomain.com/api/websites/86d4095c-a2a8-4fc8-9521-103e858e2b41/stats?startAt=1656679719687&endAt=1656766119687

{
  "pageviews": { "value": 3018, "prev": 3508 },
  "visitors": { "value": 847, "prev": 910 },
  "visits": { "value": 984, "prev": 1080 },
  "bounces": { "value": 537, "prev": 628 },
  "totaltime": { "value": 150492, "prev": 164713 }
}

pageviews: 页面浏览量
visitors: 唯一访客数量
visits: 会话数量
bounces: 仅访问单个页面的访客数量
totaltime: 在网站上花费的时间

GET /api/websites/:websiteId/metrics

获取给定时间范围的指标。

参数

startAt: 起始日期的时间戳（以毫秒为单位）。
endAt: 结束日期的时间戳（以毫秒为单位）。
type: 指标类型（url | referrer | browser | os | device | country | event）。
url: （可选）网址名称。
referrer: （可选）引用来源名称。
title: （可选）页面标题名称。
query: （可选）查询名称。
host: （可选）主机名名称。
os: （可选）操作系统名称。
browser: （可选）浏览器名称。
device: （可选）设备名称（例如，移动设备）。
country: （可选）国家名称。
region: （可选）地区/省/州名称。
city: （可选）城市名称。
language: （可选）语言名称。
event: （可选）事件名称。
limit: （可选，默认 500）返回的事件数量。

示例响应

[
  { "x": "/", "y": 46 },
  { "x": "/docs", "y": 17 },
  { "x": "/download", "y": 14 }
]

x: 独特值，取决于指标类型（url | referrer | browser | os | device | country | event）。
y: 访客数量。