plausible-rs 0.1.5

A Rust library for the Plausible Analytics API.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48

//! A Rust library for the [Plausible Analytics API](https://plausible.io/docs/events-api).
//!
//! ## Example
//!
//! Record a `pageview` event!
//!
//! `PLAUSIBLE_DOMAIN=<domain> cargo run --example event_inline`
//!
//! ```rust no_run
//! use plausible_rs::{EventHeaders, EventPayload, Plausible, PropValue, PAGEVIEW_EVENT};
//! use std::collections::HashMap;
//! use std::env;
//!
//! #[tokio::main]
//! async fn main() {
//!     let domain: String = env::var("PLAUSIBLE_DOMAIN")
//!         .expect("set env var `PLAUSIBLE_DOMAIN` to name of site in Plausible");
//!
//!     Plausible::new().event(
//!         EventHeaders::new(
//!             String::from("Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/105.0.0.0 Safari/537.36"),
//!             String::from("127.0.0.1")
//!         ),
//!         EventPayload::builder(
//!             domain.clone(),
//!             PAGEVIEW_EVENT.to_string(),
//!             format!("https://{}/test", domain)
//!         )
//!         .referrer(String::from("https://www.toddgriffin.me/"))
//!         .screen_width(2560)
//!         .props(HashMap::from([(
//!                 String::from("author"),
//!                 PropValue::from(String::from("Todd Everett Griffin")),
//!         )]))
//!         .build()
//!     ).await.unwrap();
//! }
//! ```
//!
//! For more examples, check out the `examples` directory within the repository.

mod api;
mod error;
mod plausible_analytics;

pub use api::*;
pub use error::*;
pub use plausible_analytics::*;