Plausible Analytics

Web Source code Package

Plausible Analytics is a simple, and privacy-friendly Google Analytics Alternative. The destination automatically sends events to Plausible via the plausible function. All you need to do is install the destination, and optionally map events to Plausible's format. walkerOS takes care of loading the script and the function calls.

Installation

npm install @walkeros/web-destination-plausible

Setup

import { startFlow } from '@walkeros/collector';
import { destinationPlausible } from '@walkeros/web-destination-plausible';

const { elb } = await startFlow();

elb('walker destination', destinationPlausible, {
  settings: {
    domain: 'elbwalker.com', // Optional, domain of your site as registered
  },
});

Configuration reference

Property	Type	Description	More
domain	string	The domain of your site as registered in Plausible

Settings

{
  domain: 'elbwalker.com', // Optional, domain of your site as registered
}

{ domain: 'elbwalker.com', // Optional, domain of your site as registered }

Result

No event yet.

No event yet.

Mapping examples

tip

The code examples are interactive. You can edit the code to generate your individual event mapping.

Send custom events manually using the JavaScript function

CustomEvent

Event

{
  name: "entity action",
  data: {
    string: "foo",
    number: 1,
    boolean: true,
    array: [
      0,
      "text",
      false
    ]
  },
  context: {
    dev: [
      "test",
      1
    ]
  },
  globals: {
    lang: "elb"
  },
  custom: {
    completely: "random"
  },
  user: {
    id: "us3r",
    device: "c00k13",
    session: "s3ss10n"
  },
  nested: [
    {
      entity: "child",
      data: {
        is: "subordinated"
      },
      nested: [],
      context: {
        element: [
          "child",
          0
        ]
      }
    }
  ],
  consent: {
    functional: true
  },
  id: "1760487217000-gr0up-1",
  trigger: "test",
  entity: "entity",
  action: "action",
  timestamp: 1760487217000,
  timing: 3.14,
  group: "gr0up",
  count: 1,
  version: {
    source: "0.2.0",
    tagging: 1
  },
  source: {
    type: "web",
    id: "https://localhost:80",
    previous_id: "http://remotehost:9001"
  }
}

{ name: "entity action", data: { string: "foo", number: 1, boolean: true, array: [ 0, "text", false ] }, context: { dev: [ "test", 1 ] }, globals: { lang: "elb" }, custom: { completely: "random" }, user: { id: "us3r", device: "c00k13", session: "s3ss10n" }, nested: [ { entity: "child", data: { is: "subordinated" }, nested: [], context: { element: [ "child", 0 ] } } ], consent: { functional: true }, id: "1760487217000-gr0up-1", trigger: "test", entity: "entity", action: "action", timestamp: 1760487217000, timing: 3.14, group: "gr0up", count: 1, version: { source: "0.2.0", tagging: 1 }, source: { type: "web", id: "https://localhost:80", previous_id: "http://remotehost:9001" } }

Mapping

{
  name: "Custom Event",
  data: {
    map: {
      props: "data",
      revenue: "data.number"
    }
  }
}

{ name: "Custom Event", data: { map: { props: "data", revenue: "data.number" } } }

Result

No event yet.

No event yet.

Purchase

Checkout Plausible's E-commerce revenue tracking guide to learn more about the setup within Plausible.

Event

{
  name: "order complete",
  data: {
    id: "0rd3r1d",
    currency: "EUR",
    shipping: 5.22,
    taxes: 73.76,
    total: 555
  },
  context: {
    shopping: [
      "complete",
      0
    ]
  },
  globals: {
    pagegroup: "shop"
  },
  custom: {
    completely: "random"
  },
  user: {
    id: "us3r",
    device: "c00k13",
    session: "s3ss10n"
  },
  nested: [
    {
      entity: "product",
      data: {
        id: "ers",
        name: "Everyday Ruck Snack",
        color: "black",
        size: "l",
        price: 420
      },
      context: {
        shopping: [
          "complete",
          0
        ]
      },
      nested: []
    },
    {
      entity: "product",
      data: {
        id: "cc",
        name: "Cool Cap",
        size: "one size",
        price: 42
      },
      context: {
        shopping: [
          "complete",
          0
        ]
      },
      nested: []
    },
    {
      entity: "gift",
      data: {
        name: "Surprise"
      },
      context: {
        shopping: [
          "complete",
          0
        ]
      },
      nested: []
    }
  ],
  consent: {
    functional: true
  },
  id: "1760487217000-gr0up-1",
  trigger: "load",
  entity: "order",
  action: "complete",
  timestamp: 1760487217000,
  timing: 3.14,
  group: "gr0up",
  count: 1,
  version: {
    source: "0.2.0",
    tagging: 1
  },
  source: {
    type: "web",
    id: "https://localhost:80",
    previous_id: "http://remotehost:9001"
  }
}

{ name: "order complete", data: { id: "0rd3r1d", currency: "EUR", shipping: 5.22, taxes: 73.76, total: 555 }, context: { shopping: [ "complete", 0 ] }, globals: { pagegroup: "shop" }, custom: { completely: "random" }, user: { id: "us3r", device: "c00k13", session: "s3ss10n" }, nested: [ { entity: "product", data: { id: "ers", name: "Everyday Ruck Snack", color: "black", size: "l", price: 420 }, context: { shopping: [ "complete", 0 ] }, nested: [] }, { entity: "product", data: { id: "cc", name: "Cool Cap", size: "one size", price: 42 }, context: { shopping: [ "complete", 0 ] }, nested: [] }, { entity: "gift", data: { name: "Surprise" }, context: { shopping: [ "complete", 0 ] }, nested: [] } ], consent: { functional: true }, id: "1760487217000-gr0up-1", trigger: "load", entity: "order", action: "complete", timestamp: 1760487217000, timing: 3.14, group: "gr0up", count: 1, version: { source: "0.2.0", tagging: 1 }, source: { type: "web", id: "https://localhost:80", previous_id: "http://remotehost:9001" } }

Mapping

{
  name: "purchase",
  data: {
    map: {
      revenue: {
        map: {
          currency: {
            value: "EUR"
          },
          amount: "data.total"
        }
      }
    }
  }
}

{ name: "purchase", data: { map: { revenue: { map: { currency: { value: "EUR" }, amount: "data.total" } } } } }

Result

No event yet.

No event yet.