umami-api/dev.appoutlet.umami.api/UmamiApi

UmamiApi

class UmamiApi(block: UmamiApiConfig.() -> Unit = {})

The main entry point for the Umami REST API. This class handles interactions with the Umami API (e.g. websites, users, teams) rather than simple event tracking.

Parameters

block

DSL to configure the API settings.

Constructors

UmamiApi

constructor(block: UmamiApiConfig.() -> Unit = {})

Properties

headers

val headers: SuspendMutableMap<String, String>

A suspendable map for managing custom HTTP headers. Accessible so feature classes can get/set items like Authorization.

httpClient

val httpClient: HttpClient

An HTTP client for making requests to the Umami API. This client is configured for the REST API and is not intended for public use directly.

Functions

admin

fun UmamiApi.admin(): Admin

Extension function to provide easy access to Admin functionalities from an UmamiApi instance.

auth

fun UmamiApi.auth(): Auth

Extension function to provide easy access to Auth functionalities from an UmamiApi instance.

links

fun UmamiApi.links(): Links

Extension function to provide easy access to Links functionalities from an UmamiApi instance.

fun UmamiApi.me(): Me

Extension function to provide easy access to Me functionalities from an UmamiApi instance.

pixels

fun UmamiApi.pixels(): Pixels

Extension function to provide easy access to Pixels functionalities from an UmamiApi instance.

teams

fun UmamiApi.teams(): Teams

Extension function to provide easy access to Teams functionalities from an UmamiApi instance.

users

fun UmamiApi.users(): Users

Extension function to provide easy access to Users functionalities from an UmamiApi instance.

websites

fun UmamiApi.websites(): Websites

Extension function to provide easy access to Websites functionalities from an UmamiApi instance.