网站
网站管理和统计相关操作。
端点
GET /api/websites
POST /api/websites
GET /api/websites/:websiteId
POST /api/websites/:websiteId
DELETE /api/websites/:websiteId
POST /api/websites/:websiteId/resetGET /api/websites
返回所有用户网站。
参数
includeTeams:(布尔)如果要包括您作为团队所有者的网站,请设置为 true。search:(可选字符串)搜索文本。page:(可选数字,默认1)指定页码。pageSize:(可选字符串)指定返回结果的数量。
示例响应
{
"data": [
{
"id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"name": "Example",
"domain": "example.com",
"shareId": null,
"resetAt": null,
"userId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"teamId": null,
"createdBy": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"createdAt": "0000-00-00T00:00:00.000Z",
"updatedAt": "0000-00-00T00:00:00.000Z",
"deletedAt": null,
"user": {
"username": "bob@aol.com",
"id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
}
}
],
"count": 1,
"page": 1,
"pageSize": 10
}POST /api/websites
创建一个网站。
参数
name:(字符串)网站在 Umami 中的名称。domain:(字符串)被跟踪网站的完整域名。shareId:(字符串 | 可选)一个唯一字符串,用于启用分享 URL。设为null取消分享。teamId:(字符串 | 可选)网站将归属的团队 ID。id:(字符串 | 可选)强制为网站分配指定 UUID。
请求体
{
"name": "Test",
"domain": "example.com"
}示例响应
{
"id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"name": "Test",
"domain": "example.com",
"shareId": null,
"resetAt": null,
"userId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"teamId": null,
"createdBy": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"createdAt": "0000-00-00T00:00:00.000Z",
"updatedAt": "0000-00-00T00:00:00.000Z",
"deletedAt": null
}GET /api/websites/:websiteId
根据 ID 获取网站。
示例响应
{
"id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"name": "Example",
"domain": "example.com",
"shareId": null,
"resetAt": null,
"userId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"teamId": null,
"createdBy": "133660ed-e51c-4ed9-84aa-c86654460cae",
"createdAt": "2025-10-10T22:01:06.201Z",
"updatedAt": "2025-10-10T22:02:02.220Z",
"deletedAt": null
}POST /api/websites/:websiteId
更新网站。
参数
name:(字符串)网站在 Umami 中的名称。domain:(字符串)被跟踪网站的完整域名。shareId:(字符串 | 可选)一个唯一字符串,用于启用分享 URL。设为null取消分享。
请求体
{
"name": "Test",
"domain": "domain.com"
}示例响应
{
"id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"name": "Example",
"domain": "example.com",
"shareId": null,
"resetAt": null,
"userId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"teamId": null,
"createdBy": "133660ed-e51c-4ed9-84aa-c86654460cae",
"createdAt": "2025-10-10T22:01:06.201Z",
"updatedAt": "2025-10-10T22:02:02.220Z",
"deletedAt": null
}DELETE /api/websites/:websiteId
删除网站。
示例响应
{
"ok": true
}POST /api/websites/:websiteId/reset
重置网站,删除与该网站相关的所有数据。
示例响应
{
"ok": true
}