Share – umami

Endpoints

Operations around Share page management.

Endpoints

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/shares

POST /api/share#

Creates a share page.

Parameters

Parameter	Type	Description
`entityId`	string	ID of 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 share page.

Request body

{
	"entityId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
	"shareType": 1,
	"name": "My Share Page",
	"slug": "abc123defg",
	"parameters": { "overview": true, "events": true}
}

Sample 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:03:51.718Z"
}

GET /api/share/id/:shareId#

Gets a share page by ID.

Sample 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#

Updates a share page.

Parameters

Parameter	Type	Description
`name`	string	Name of the share page.
`slug`	string	Slug of the share page.
`parameters`	object	Parameters for share page.

Request body

{
	"name": "My Updated Share Page",
	"slug": "abc123defg",
	"parameters": { "overview": true, "events": true, "funnel": true, "utm": true}
}

Sample 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#

Deletes a share page.

Sample response

{
  "ok": true
}

GET /api/websites/:websiteId/shares#

Gets all share pages that belong to a website.

Sample response

{
	"data": [
		{
			"id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
			"entityId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
			"name": "Umami Live Demo",
			"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#

Creates a share page belonging to a website.

Parameters

Parameter	Type	Description
`name`	string	Name of the share page.
`parameters`	object	Parameters for share page.

Request body

{
	"name": "My Websites Share Page",
	"parameters": { "utm": true, "goals": true, "events": true }
}

Sample response

{
	"id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
	"entityId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
	"name": "My Websites 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"
}

PreviousSessions NextTeams