像素管理
关于像素管理的操作。
接口列表
GET /api/pixels
POST /api/pixels
GET /api/pixels/:pixelId
POST /api/pixels/:pixelId
DELETE /api/pixels/:pixelIdGET /api/pixels
返回所有用户的像素。
参数
| Parameter | Type | Description |
|---|---|---|
search | string | （可选）搜索文本。 |
page | number | （可选，默认 1）确定页码。 |
pageSize | number | （可选）确定返回多少结果。 |
示例响应
{
"data": [
{
"id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"name": "Umami Pixel",
"slug": "xxxxxxxx",
"userId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"teamId": null,
"createdAt": "2025-10-27T18:50:54.079Z",
"updatedAt": "2025-10-27T18:50:54.079Z",
"deletedAt": null
}
],
"count": 1,
"page": 1,
"pageSize": 20
}POST /api/pixels
创建一个像素。
参数
| Parameter | Type | Description |
|---|---|---|
name | string | 像素的名称。 |
slug | string | 像素的 URL slug（至少 8 个字符）。 |
teamId | string | （可选）创建该像素时所属团队的 ID。 |
请求体
{
"name": "Umami Pixel",
"slug": "pixel123"
}示例响应
{
"id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"name": "Umami Pixel",
"slug": "pixel123",
"userId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"teamId": null,
"createdAt": "2025-10-27T18:50:54.079Z",
"updatedAt": "2025-10-27T18:50:54.079Z",
"deletedAt": null
}GET /api/pixels/:pixelId
根据 ID 获取指定像素。
示例响应
{
"id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"name": "Umami Pixel",
"slug": "xxxxxxxx",
"userId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"teamId": null,
"createdAt": "2025-10-27T18:50:54.079Z",
"updatedAt": "2025-10-27T18:50:54.079Z",
"deletedAt": null
}POST /api/pixels/:pixelId
更新指定像素。
参数
| Parameter | Type | Description |
|---|---|---|
name | string | （可选）像素的名称。 |
slug | string | （可选）像素的 URL slug（至少 8 个字符）。 |
请求体
{
"name": "Umami Pixel",
"slug": "abcde123"
}示例响应
{
"id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"name": "Umami Pixel",
"slug": "abcde123",
"userId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"teamId": null,
"createdAt": "2025-10-27T18:50:54.079Z",
"updatedAt": "2025-10-30T23:11:18.627Z",
"deletedAt": null
}DELETE /api/pixels/:pixelId
删除指定像素。
示例响应
{
"ok": true
}