与网站管理和统计相关的操作。
端点
GET /api/websites
POST /api/websites
GET /api/websites/:websiteId
POST /api/websites/:websiteId
DELETE /api/websites/:websiteId
POST /api/websites/:websiteId/reset
返回所有被跟踪的网站。
参数
query: （可选字符串）搜索文本。page: （可选数字，默认值 1）确定页码。pageSize: （可选字符串）确定返回多少结果。orderBy: （可选字符串，默认值 name）按列名排序。示例响应
[
{
"id": "02d89813-7a72-41e1-87f0-8d668f85008b",
"name": "我的网站",
"domain": "mywebsite.com",
"shareId": null,
"resetAt": null,
"websiteId": "1a457e1a-121a-11ee-be56-0242ac120002",
"createdAt": "2023-04-10T23:06:44.250Z",
"updatedAt": null,
"deletedAt": null
}
]
创建一个网站。
参数
domain: （字符串）被跟踪网站的完整域名。name: （字符串）Umami 中的网站名称。shareId: （可选字符串）一个唯一字符串以启用共享 URL。设置为 null 以取消共享。teamId: （可选字符串）创建网站所在团队的 ID。示例响应
{
"id": 4,
"websiteUuid": "51f73213-3f01-4343-a135-25496a3ffd31",
"websiteId": 2,
"name": "Umami",
"domain": "umami.is",
"shareId": "8PWex1pa",
"createdAt": "2021-07-26T17:17:52.846Z"
}
通过 ID 获取网站。
参数
无
示例响应
{
"id": "02d89813-7a72-41e1-87f0-8d668f85008b",
"name": "我的网站",
"domain": "mywebsite.com",
"shareId": null,
"resetAt": null,
"userId": "1a457e1a-121a-11ee-be56-0242ac120002",
"createdAt": "2023-04-10T23:06:44.250Z",
"updatedAt": null,
"deletedAt": null
}
更新网站。
参数
name: （可选字符串）Umami 中的网站名称。domain: （可选字符串）被跟踪网站的完整域名。shareId: （可选字符串）一个唯一字符串以启用共享 URL。设置为 null 以取消共享。示例响应
{
"id": "02d89813-7a72-41e1-87f0-8d668f85008b",
"name": "我的网站",
"domain": "mywebsite.com",
"shareId": null,
"resetAt": null,
"userId": "1a457e1a-121a-11ee-be56-0242ac120002",
"createdAt": "2023-04-10T23:06:44.250Z",
"updatedAt": null,
"deletedAt": null
}
删除一个网站。
参数
无
示例响应
ok
通过移除与网站相关的所有数据重置网站。
参数
无
示例响应
ok