Websites

class Websites(umami: Umami)

Provides functionalities for interacting with Websites in the Umami API.

umami

The Umami instance used for making HTTP requests.

Constructors

constructor(umami: Umami)

suspend fun createWebsite(name: String, domain: String, shareId: String? = null, teamId: String? = null, id: String? = null): Website

Creates a new website.

suspend fun deleteWebsite(websiteId: String)

Deletes a website from the Umami API.

suspend fun getWebsite(websiteId: String): Website

Retrieves a single website from the Umami API by its ID.

suspend fun getWebsites(includeTeams: Boolean? = null, search: String? = null, page: Int? = null, pageSize: Int? = null): SearchResponse<Website>

Retrieves a paginated list of websites from the Umami API.

suspend fun resetWebsite(websiteId: String)

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

suspend fun updateWebsite(websiteId: String, name: String? = null, domain: String? = null, shareId: String? = null): Website

Updates an existing website.