Websites API

The Websites API provides a convenient way to interact with the website-related endpoints of the Umami API.

To get started, you can access the Websites API from your Umami instance:

val umami = Umami(website = "your-website-id")
val websitesApi = umami.websites()

Get all websites

You can retrieve a list of all websites available to the user. This method supports pagination and searching.

val websites = websitesApi.getWebsites(
    search = "example.com",
    page = 1,
    pageSize = 10
)

To retrieve a single website by its ID, use the getWebsite method:

val websiteId = "your-website-id"
val website = websitesApi.getWebsite(websiteId)

You can create a new website by providing a name and domain:

val newWebsite = websitesApi.createWebsite(
    name = "My New Website",
    domain = "new-website.com"
)

To update an existing website, you need its ID and the new data:

val websiteId = "your-website-id"
val updatedWebsite = websitesApi.updateWebsite(
    websiteId = websiteId,
    name = "My Updated Website Name"
)

You can delete a website by its ID. This operation does not return any data.

val websiteId = "your-website-id"
websitesApi.deleteWebsite(websiteId)

To reset all data for a website, use the resetWebsite method. This operation also does not return any data.

val websiteId = "your-website-id"
websitesApi.resetWebsite(websiteId)