入门
发送统计信息
On this page
要注册一个 event
,您需要发送一个 POST
请求到 /api/send
,并附上以下数据:
对于 Umami Cloud,请发送 POST 请求到 https://cloud.umami.is/api/send
。
参数
payload
hostname
: (字符串) 主机名称。language
: (字符串) 访问者的语言(例如 "zh-CN")。referrer
: (字符串) 引荐 URL。screen
: (字符串) 屏幕分辨率(例如 "1920x1080")。title
: (字符串) 页面标题。url
: (字符串) 页面 URL。website
: (字符串) 网站 ID。name
: (字符串) 事件名称。data
: (对象)(可选) 事件的附加数据。type
: (字符串) 当前唯一可用的类型是 event
。
示例负载
{
"payload": {
"hostname": "your-hostname",
"language": "en-US",
"referrer": "",
"screen": "1920x1080",
"title": "dashboard",
"url": "/",
"website": "your-website-id",
"name": "event-name",
"data": {
"foo": "bar"
}
},
"type": "event"
}
注意,对于 /api/send
请求,您无需发送身份验证令牌。
另外,您需要发送一个正确的 User-Agent
HTTP 头,否则您的请求将不会被注册。
程序化操作
您可以使用 JavaScript 和浏览器 APIs 程序化生成这些值。例如:
const data = {
payload: {
hostname: window.location.hostname,
language: navigator.language,
referrer: document.referrer,
screen: `${window.screen.width}x${window.screen.height}`,
title: document.title,
url: window.location.pathname,
website: 'your-website-id',
name: 'event-name',
},
type: 'event',
};