umami-api/dev.appoutlet.umami.domain

Package-level declarations

Types

@Serializable

data class Team(val id: String, val name: String, val accessCode: String, val logoUrl: String? = null, val createdAt: Instant, val updatedAt: Instant, val deletedAt: Instant? = null, val members: List<User> = emptyList())

A team in Umami.

User

@Serializable

data class User(val id: String, val username: String, val role: String, val createdAt: Instant, val updatedAt: Instant? = null, val deletedAt: Instant? = null, val logoUrl: String? = null, val displayName: String? = null, val isAdmin: Boolean = false, val teams: List<Team> = emptyList(), val count: UserCount? = null)

Represents a user in the Umami analytics platform.

UserCount

@Serializable

data class UserCount(val websites: Int)

A nested data class to represent the _count object in the User model.

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.