Pixels

class Pixels(umami: Umami)

Provides functionalities for interacting with Pixels in the Umami API.

Parameters

umami

The Umami instance used for making HTTP requests.

Constructors

Link copied to clipboard
constructor(umami: Umami)

Functions

Link copied to clipboard
suspend fun deletePixel(pixelId: String)

Deletes a pixel from the Umami API.

Link copied to clipboard
suspend fun getPixel(pixelId: String): Pixel

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

Link copied to clipboard
suspend fun getPixels(search: String? = null, page: Int? = null, pageSize: Int? = null): SearchResponse<Pixel>

Retrieves a paginated list of pixels from the Umami API.

Link copied to clipboard
suspend fun updatePixel(pixelId: String, name: String? = null, slug: String? = null): Pixel

Updates an existing pixel.