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

Website

@Serializable

data class Website(val id: String, val name: String, val domain: String, val shareId: String? = null, val resetAt: Instant? = null, val userId: String, val teamId: String? = null, val createdBy: String, val createdAt: Instant, val updatedAt: Instant? = null, val deletedAt: Instant? = null, val user: User? = null, val team: Team? = null)

Represents a website in the Umami analytics platform.

This data class maps to the website object returned by various Umami API endpoints including GET /api/websites/:websiteId and GET /api/websites.

See also

Constructors

constructor(id: String, name: String, domain: String, shareId: String? = null, resetAt: Instant? = null, userId: String, teamId: String? = null, createdBy: String, createdAt: Instant, updatedAt: Instant? = null, deletedAt: Instant? = null, user: User? = null, team: Team? = null)

Properties

@SerialName(value = "createdAt")

val createdAt: Instant

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

@SerialName(value = "createdBy")

val createdBy: String

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

@SerialName(value = "deletedAt")

val deletedAt: Instant?

The timestamp when the website was deleted (ISO 8601 format).

@SerialName(value = "domain")

val domain: String

The domain of the website.

@SerialName(value = "id")

The unique identifier of the website (UUID format).

@SerialName(value = "name")

val name: String

The name of the website.

@SerialName(value = "resetAt")

val resetAt: Instant?

The timestamp when the website's statistics were reset (ISO 8601 format).

@SerialName(value = "shareId")

val shareId: String?

The share ID of the website, if it is shared publicly.

@SerialName(value = "team")

val team: Team?

The team that owns the website.

@SerialName(value = "teamId")

val teamId: String?

The unique identifier of the team that owns the website (UUID format).

@SerialName(value = "updatedAt")

val updatedAt: Instant?

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

@SerialName(value = "user")

val user: User?

The user who owns the website.

@SerialName(value = "userId")

val userId: String

The unique identifier of the user who owns the website (UUID format).