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

Link

@Serializable

data class Link(val id: String, val name: String, val url: String, val slug: String, val userId: String, val teamId: String? = null, val createdAt: Instant, val updatedAt: Instant, val deletedAt: Instant? = null)

Represents a Link entity in the Umami analytics platform.

This data class maps to the link object returned by various Umami API endpoints.

See also

Constructors

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

Properties

@SerialName(value = "createdAt")

val createdAt: Instant

The timestamp when the link was created (ISO 8601 format).

@SerialName(value = "deletedAt")

val deletedAt: Instant?

The timestamp when the link was deleted (ISO 8601 format). Can be null.

@SerialName(value = "id")

The unique identifier of the link (UUID format).

@SerialName(value = "name")

val name: String

The name of the link.

@SerialName(value = "slug")

val slug: String

The unique slug identifier for the link.

@SerialName(value = "teamId")

val teamId: String?

The unique identifier of the team the link belongs to (UUID format). Can be null.

@SerialName(value = "updatedAt")

val updatedAt: Instant

The timestamp when the link was last updated (ISO 8601 format).

@SerialName(value = "url")

val url: String

The URL that the link points to.

@SerialName(value = "userId")

val userId: String

The unique identifier of the user who created the link (UUID format).