Websites
Operations around Website management and statistics.
Endpoints
GET /api/websites
POST /api/websites
GET /api/websites/:websiteId
POST /api/websites/:websiteId
DELETE /api/websites/:websiteId
POST /api/websites/:websiteId/resetGET /api/websites
Returns all user websites.
Parameters
| Parameter | Type | Description |
|---|---|---|
includeTeams | boolean | Set to true to include websites where you are the team owner. |
search | string | (optional) Search text. |
page | number | (optional, default 1) Determines page. |
pageSize | number | (optional) Determines how many results to return. |
Sample response
{
"data": [
{
"id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"name": "Example",
"domain": "example.com",
"shareId": null,
"resetAt": null,
"userId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"teamId": null,
"createdBy": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"createdAt": "0000-00-00T00:00:00.000Z",
"updatedAt": "0000-00-00T00:00:00.000Z",
"deletedAt": null,
"user": {
"username": "[email protected]",
"id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
}
}
],
"count": 1,
"page": 1,
"pageSize": 10
}POST /api/websites
Creates a website.
Parameters
| Parameter | Type | Description |
|---|---|---|
name | string | The name of the website in Umami. |
domain | string | The full domain of the tracked website. |
shareId | string | (optional) A unique string to enable a share URL. Set null to unshare. |
teamId | string | (optional) The ID of the team the website will be created under. |
id | string | (optional) Force a UUID assignment to the website. |
Request body
{
"name": "Test",
"domain": "example.com"
}Sample response
{
"id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"name": "Test",
"domain": "example.com",
"shareId": null,
"resetAt": null,
"userId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"teamId": null,
"createdBy": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"createdAt": "0000-00-00T00:00:00.000Z",
"updatedAt": "0000-00-00T00:00:00.000Z",
"deletedAt": null
}GET /api/websites/:websiteId
Gets a website by ID.
Sample response
{
"id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"name": "Example",
"domain": "example.com",
"shareId": null,
"resetAt": null,
"userId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"teamId": null,
"createdBy": "133660ed-e51c-4ed9-84aa-c86654460cae",
"createdAt": "2025-10-10T22:01:06.201Z",
"updatedAt": "2025-10-10T22:02:02.220Z",
"deletedAt": null
}POST /api/websites/:websiteId
Updates a website.
Parameters
| Parameter | Type | Description |
|---|---|---|
name | string | The name of the website in Umami. |
domain | string | The full domain of the tracked website. |
shareId | string | (optional) A unique string to enable a share URL. Set null to unshare. |
Request body
{
"name": "Test",
"domain": "domain.com"
}Sample response
{
"id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"name": "Example",
"domain": "example.com",
"shareId": null,
"resetAt": null,
"userId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"teamId": null,
"createdBy": "133660ed-e51c-4ed9-84aa-c86654460cae",
"createdAt": "2025-10-10T22:01:06.201Z",
"updatedAt": "2025-10-10T22:02:02.220Z",
"deletedAt": null
}DELETE /api/websites/:websiteId
Deletes a website.
Sample response
{
"ok": true
}POST /api/websites/:websiteId/reset
Resets a website by removing all data related to the website.
Sample response
{
"ok": true
}