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

---

GET /api/websites

Returns all tracked websites.

Parameters

• query: (optional string) Search text.
• page: (optional number, default 1) Determines page.
• pageSize: (optional string) Determines how many results to return.
• orderBy: (optional string, default name) Order by column name.

Sample response

[
  {
    "id": "02d89813-7a72-41e1-87f0-8d668f85008b",
    "name": "My Website",
    "domain": "mywebsite.com",
    "shareId": null,
    "resetAt": null,
    "websiteId": "1a457e1a-121a-11ee-be56-0242ac120002",
    "createdAt": "2023-04-10T23:06:44.250Z",
    "updatedAt": null,
    "deletedAt": null
  }
]

---

POST /api/websites

Creates a website.

Parameters

• domain: (string) The full domain of the tracked website.
• name: (string) The name of the website in Umami.
• shareId: (optional string) A unique string to enable a share url. Set null to unshare.
• teamId: (optional string) The ID of the team the website will be created under.

Sample response

{
  "id": 4,
  "websiteUuid": "51f73213-3f01-4343-a135-25496a3ffd31",
  "websiteId": 2,
  "name": "Umami",
  "domain": "umami.is",
  "shareId": "8PWex1pa",
  "createdAt": "2021-07-26T17:17:52.846Z"
}

---

GET /api/websites/:websiteId

Gets a website by ID.

Parameters

None

Sample response

{
  "id": "02d89813-7a72-41e1-87f0-8d668f85008b",
  "name": "My Website",
  "domain": "mywebsite.com",
  "shareId": null,
  "resetAt": null,
  "userId": "1a457e1a-121a-11ee-be56-0242ac120002",
  "createdAt": "2023-04-10T23:06:44.250Z",
  "updatedAt": null,
  "deletedAt": null
}

---

POST /api/websites/:websiteId

Updates a website.

Parameters

• name: (optional string) The name of the website in Umami.
• domain: (optional string) The full domain of the tracked website.
• shareId: (optional string) A unique string to enable a share url. Set null to unshare.

Sample response

{
  "id": "02d89813-7a72-41e1-87f0-8d668f85008b",
  "name": "My Website",
  "domain": "mywebsite.com",
  "shareId": null,
  "resetAt": null,
  "userId": "1a457e1a-121a-11ee-be56-0242ac120002",
  "createdAt": "2023-04-10T23:06:44.250Z",
  "updatedAt": null,
  "deletedAt": null
}

---

DELETE /api/websites/:websiteId

Deletes a website.

Parameters

None

Sample response

ok

---

POST /api/websites/:websiteId/reset

Resets a website by removing all data related to the website.

Parameters

None

Sample response

ok