Struct PlausibleClient 

pub struct PlausibleClient { /* private fields */ }

High-level Plausible API client.

Implementations

impl PlausibleClient

pub fn new(api_key: impl Into<String>) -> Result<Self, ClientError>

Create a new client targeting the public Plausible API endpoint.

pub fn with_base_url( api_key: impl Into<String>, base_url: Url, ) -> Result<Self, ClientError>

Create a client with a custom base URL (useful for self-hosted Plausible).

pub fn base_url(&self) -> &Url

Returns the effective base URL.

pub fn user_agent(&self) -> &str

Returns the configured user agent string.

pub async fn list_sites(&self) -> Result<Vec<SiteSummary>, ClientError>

Fetch the list of sites accessible to the API key.

pub async fn create_site( &self, request: &CreateSiteRequest, ) -> Result<SiteSummary, ClientError>

Create a Plausible site.

pub async fn update_site( &self, site_id: &str, request: &UpdateSiteRequest, ) -> Result<SiteSummary, ClientError>

Update mutable properties for a Plausible site.

pub async fn reset_site_stats( &self, site_id: &str, request: &ResetSiteStatsRequest, ) -> Result<(), ClientError>

Reset statistics for a site.

pub async fn delete_site(&self, site_id: &str) -> Result<(), ClientError>

Delete a Plausible site.

pub async fn stats_aggregate( &self, query: &AggregateQuery, ) -> Result<AggregateResponse, ClientError>

Query aggregate statistics for a site.

pub async fn stats_timeseries( &self, query: &TimeseriesQuery, ) -> Result<TimeseriesResponse, ClientError>

Query timeseries statistics for a site.

pub async fn stats_breakdown( &self, query: &BreakdownQuery, ) -> Result<BreakdownResponse, ClientError>

Query breakdown statistics for a site.

pub async fn stats_realtime_visitors( &self, site_id: &str, ) -> Result<RealtimeVisitorsResponse, ClientError>

Fetch realtime visitor counts.

pub async fn send_event(&self, event: &Value) -> Result<(), ClientError>

Send a custom event to Plausible.

Trait Implementations

impl Clone for PlausibleClient

fn clone(&self) -> PlausibleClient

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PlausibleClient

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

Formats the value using the given formatter.