Struct plausible_rs::EventHeaders

pub struct EventHeaders {
    pub user_agent: String,
    pub x_forwarded_for: String,
}

Request headers for the ‘POST /api/event’ API.

Fields

user_agent: String

The raw value of User-Agent is used to calculate the user_id which identifies a unique visitor in Plausible.

User-Agent is also used to populate the Devices report in your Plausible dashboard. The device data is derived from the open source database device-detector. If your User-Agent is not showing up in your dashboard, it’s probably because it is not recognized as one in the device-detector database.

x_forwarded_for: String

Used to get the IP address of the client.

The IP address is used to calculate the user_id which identifies a unique visitor in Plausible. The raw value is anonymized and not stored. If the header contains a comma-separated list (as it should if the request is sent through a chain of proxies), then the first valid IP address from the list is used.

More information can be found on MDN docs.

Implementations

impl EventHeaders

pub const fn new(user_agent: String, x_forwarded_for: String) -> Self

Examples found in repository

examples/event.rs (lines 11-14)

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();
}

Trait Implementations

impl Clone for EventHeaders

fn clone(&self) -> EventHeaders

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for EventHeaders

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

Formats the value using the given formatter.