getWebsites

Retrieves a paginated and searchable list of all websites.

Return

A Websites.Response object containing the list of websites and pagination metadata.

Parameters

request

The request object containing search, page, and pageSize parameters.


suspend fun Umami.getWebsites(search: String? = null, page: Int? = null, pageSize: Int? = null): Websites.Response

Retrieves a paginated and searchable list of all websites. This is a convenience function that creates a Websites.Request object.

Return

A Websites.Response object containing the list of websites and pagination metadata.

Parameters

search

Optional search query to filter websites by name or other attributes.

page

Optional page number for pagination (1-indexed).

pageSize

Optional number of websites per page.