umami-api/dev.appoutlet.umami.domain

Package-level declarations

Types

@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.

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.

SearchResponse

@Serializable

data class SearchResponse<T>(val data: List<T>, val count: Long, val page: Int, val pageSize: Int, val orderBy: String? = null)

Represents a generic search response structure from the Umami API. This data class encapsulates paginated results and metadata about the search.

Session

@Serializable

data class Session(val token: String, val authKey: String, val shareToken: String? = null, val user: User)

Represents a session in the Umami analytics platform.

Team

@Serializable

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

A team in Umami.

TeamMember

@Serializable

data class TeamMember(val id: String, val teamId: String, val userId: String, val role: String, val createdAt: Instant, val updatedAt: Instant, val user: User? = null)

A member of a team.

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())

Represents a user in the Umami analytics platform.

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.