分享
分享页面管理相关操作。
端点
POST /api/share
GET /api/share/id/:shareId
POST /api/share/id/:shareId
DELETE /api/share/id/:shareId
GET /api/websites/:websiteId/shares
POST /api/websites/:websiteId/sharesPOST /api/share
Create a share page.
Parameters
| Parameter | Type | Description |
|---|---|---|
entityId | string | ID of the entity to be added (websiteId, pixelId, linkId, etc.). |
shareType | number | website: 1 | link: 2 | pixel: 3 | board: 4 |
name | string | Name of the share page. |
slug | string | Slug of the share page. |
parameters | object | Parameters for the share page. |
Request body
{
"entityId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"shareType": 1,
"name": "我的分享页面",
"slug": "abc123defg",
"parameters": { "overview": true, "events": true}
}Example response
{
"id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"entityId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"name": "我的分享页面",
"shareType": 1,
"slug": "abc123defg",
"parameters": {
"events": true,
"overview": true
},
"createdAt": "2026-01-30T06:03:51.718Z",
"updatedAt": "2026-01-30T06:03:51.718Z"
}GET /api/share/id/:shareId
Get the share page by ID.
Example response
{
"id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"entityId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"name": "My share page",
"shareType": 1,
"slug": "abc123defg",
"parameters": {
"events": true,
"overview": true
},
"createdAt": "2026-01-30T06:03:51.718Z",
"updatedAt": "2026-01-30T06:06:32.197Z"
}POST /api/share/id/:shareId
Update the share page.
Parameters
| Parameter | Type | Description |
|---|---|---|
name | string | Share page name. |
slug | string | Share page slug. |
parameters | object | Share page parameters. |
Request Body
{
"name": "My updated share page",
"slug": "abc123defg",
"parameters": { "overview": true, "events": true, "funnel": true, "utm": true}
}Example Response
{
"id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"entityId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"name": "My updated share page",
"shareType": 1,
"slug": "abc123defg",
"parameters": {
"utm": true,
"events": true,
"funnel": true,
"overview": true
},
"createdAt": "2026-01-30T06:03:51.718Z",
"updatedAt": "2026-01-30T06:09:05.640Z"
}DELETE /api/share/id/:shareId
删除分享页面。
示例响应
{
"ok": true
}GET /api/websites/:websiteId/shares
获取属于某个网站的所有分享页面。
示例响应
{
"data": [
{
"id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"entityId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"name": "Umami 直播演示",
"shareType": 1,
"slug": "xxxxxxxxxxxxxx",
"parameters": {
"utm": false,
"goals": true,
"events": true,
"compare": false,
"funnels": true,
"revenue": false,
"journeys": false,
"overview": true,
"realtime": false,
"sessions": true,
"breakdown": false,
"retention": false,
"attribution": false
},
"createdAt": "2026-01-29T18:51:40.489Z",
"updatedAt": "2026-01-29T18:51:40.489Z"
}
],
"count": 1,
"page": 1,
"pageSize": 20
}POST /api/websites/:websiteId/shares
Create a share page belonging to a specific website.
Parameters
| Parameter | Type | Description |
|---|---|---|
name | string | Share page name. |
parameters | object | Share page parameters. |
Request Body
{
"name": "My website share page",
"parameters": { "utm": true, "goals": true, "events": true }
}Example Response
{
"id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"entityId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"name": "My website share page",
"shareType": 1,
"slug": "xxxxxxxxx",
"parameters": {
"utm": false,
"goals": true,
"events": true
},
"createdAt": "2026-01-30T06:03:51.718Z",
"updatedAt": "2026-01-30T06:09:05.640Z"
}