像素管理

关于像素管理的操作。

接口列表

GET /api/pixels
GET /api/pixels/:pixelId
POST /api/pixels/:pixelId
DELETE /api/pixels/:pixelId

GET /api/pixels

返回所有用户的像素。

参数

  • search:(可选字符串)搜索文本。
  • page:(可选数字,默认 1)指定页码。
  • pageSize:(可选字符串)指定返回结果数量。

示例响应

{
  "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
}

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

更新指定像素。

参数

  • name:(可选字符串)像素名称。
  • slug:(可选字符串,最少 8 个字符)链接的 URL 别名。

请求体

{
  "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
}