umami-api/dev.appoutlet.umami.domain/Pixel

Pixel

@Serializable

data class Pixel(val id: String, val name: String, val slug: String, val userId: String, val teamId: String?, val createdAt: Instant, val updatedAt: Instant, val deletedAt: Instant?)

Represents a tracking pixel in the Umami analytics platform. A tracking pixel is a 1x1 transparent image used to track website visits or other events.

This data class maps to the pixel object returned by the Umami API.

Constructors

Pixel

constructor(id: String, name: String, slug: String, userId: String, teamId: String?, createdAt: Instant, updatedAt: Instant, deletedAt: Instant?)

Properties

createdAt

@SerialName(value = "createdAt")

val createdAt: Instant

The timestamp indicating when the tracking pixel was created, in ISO 8601 format.

deletedAt

@SerialName(value = "deletedAt")

val deletedAt: Instant?

The timestamp indicating when the tracking pixel was deleted, in ISO 8601 format. This will be null if the pixel has not been deleted.

@SerialName(value = "id")

val id: String

The unique identifier for the tracking pixel, in UUID format. This ID is used to reference the pixel in API calls.

name

@SerialName(value = "name")

val name: String

The descriptive name assigned to the tracking pixel for easy identification.

slug

@SerialName(value = "slug")

val slug: String

The unique URL slug for the tracking pixel. This slug is part of the URL used to trigger the tracking event.

teamId

@SerialName(value = "teamId")

val teamId: String?

The unique identifier of the team that the tracking pixel belongs to, in UUID format. This can be null if the pixel is not associated with a team.

updatedAt

@SerialName(value = "updatedAt")

val updatedAt: Instant

The timestamp indicating when the tracking pixel was last updated, in ISO 8601 format.

userId

@SerialName(value = "userId")

val userId: String

The unique identifier of the user who owns this tracking pixel, in UUID format.

Pixel

See also

Constructors

Properties