Miosa.Usage (Miosa v1.0.1)

Copy Markdown View Source

Usage — current period summary, per-session metering, and report queries.

Example

client = Miosa.client(System.fetch_env!("MIOSA_API_KEY"))

{:ok, summary} = Miosa.Usage.current(client)
{:ok, sessions} = Miosa.Usage.sessions(client, %{limit: 100})

Summary

Functions

Get the current period usage summary.

Get a usage report for a period.

List per-session metering events.

Functions

current(client)

@spec current(Miosa.Client.t()) :: Miosa.Client.result(map())

Get the current period usage summary.

report(client, filters \\ [])

@spec report(Miosa.Client.t(), keyword() | map()) :: Miosa.Client.result(map())

Get a usage report for a period.

Options: :period_start and :period_end (ISO 8601 strings), plus any additional filters accepted by the API.

sessions(client, filters \\ [])

@spec sessions(Miosa.Client.t(), keyword() | map()) :: Miosa.Client.result(map())

List per-session metering events.

Accepts optional filters as a keyword list or map (e.g. :limit, :cursor, :computer_id).