Skip to main content

Client

Struct Client 

Source
pub struct Client { /* private fields */ }
Expand description

Async client for Umami’s unauthenticated analytics ingestion API.

The client is cheap to clone and is stateless, making it safe to share across visitors. Use Client::session when sending a sequence of tracks for one visitor and you want automatic cache reuse.

Implementations§

Source§

impl Client

Source

pub fn new( instance_url: impl Into<String>, website_id: impl ToString, ) -> Result<Self>

Creates a client for a self-hosted Umami instance.

instance_url may be the instance root (https://analytics.example.com), its API root (https://analytics.example.com/api), or the exact send endpoint (https://analytics.example.com/api/send).

Source

pub fn cloud(website_id: impl ToString) -> Result<Self>

Creates a client for Umami Cloud’s public collection gateway.

Source

pub fn builder( instance_url: impl Into<String>, website_id: impl ToString, ) -> ClientBuilder

Starts a configurable client builder.

Source

pub fn website_id(&self) -> Uuid

Returns the configured website ID.

Source

pub fn endpoint(&self) -> &Url

Returns the single-track collection endpoint.

Source

pub fn batch_endpoint(&self) -> &Url

Returns the batch collection endpoint.

Source

pub fn default_context(&self) -> &Context

Returns the default context inherited by new tracks.

Source

pub fn pageview(&self, url: impl Into<String>) -> Track

Creates a pageview track.

Source

pub fn event(&self, name: impl Into<String>) -> Track

Creates a named custom-event track.

Source

pub fn identify(&self, distinct_id: impl Into<String>) -> Track

Creates an identify track for a stable distinct ID.

Source

pub fn identify_anonymous(&self) -> Track

Creates an identify track that associates properties without assigning a distinct ID.

Source

pub fn performance(&self, url: impl Into<String>) -> Track

Creates a Core Web Vitals performance track.

Source

pub fn batch(&self) -> Batch

Starts an empty analytics batch.

Source

pub fn session(&self) -> Session

Creates isolated state for a sequence of tracks from one visitor.

Clones of the returned session share its cache, while other sessions and the client itself remain independent.

Trait Implementations§

Source§

impl Clone for Client

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for Client

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more