Plausible Analytics

Source code Package Browser ES5

Plausible Analytics is a simple, and privacy-friendly Google Analytics Alternative. The destination sends events to Plausible via the plausible function.

Installation

TypeScript

Install the destination via npm

npm i @elbwalker/destination-web-plausible

import { elb } from '@elbwalker/walker.js';
import destinationPlausible from '@elbwalker/destination-web-plausible';

elb('walker destination', destinationPlausible, config);

Script

Load the destination via dynamic import

<script>
  // Upload the dist/index.mjs on your own server
  const destination = (
    await import(
      'https://cdn.jsdelivr.net/npm/@elbwalker/destination-web-plausible/dist/index.mjs'
    )
  ).default;

  elb('walker destination', destination, config);
</script>

Code

Copy the code from the index.browser.js file

(function () {
  'use strict';
  var Destination = (() => {})(); // This is the copied code

  elb('walker destination', Destination.default, config);
})();

Configuration

Configure your Plausible destination.

Custom Config

{
  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.

Custom

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

Mapping

Send custom events manually using the JavaScript function

CustomEvent

Event

{
  event: "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: [
    {
      type: "child",
      data: {
        is: "subordinated"
      },
      nested: [],
      context: {
        element: [
          "child",
          0
        ]
      }
    }
  ],
  consent: {
    functional: true
  },
  id: "1741911217000-gr0up-1",
  trigger: "test",
  entity: "entity",
  action: "action",
  timestamp: 1741911217000,
  timing: 3.14,
  group: "gr0up",
  count: 1,
  version: {
    source: "0.0.7",
    tagging: 1
  },
  source: {
    type: "web",
    id: "https://localhost:80",
    previous_id: "http://remotehost:9001"
  }
}

{ event: "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: [ { type: "child", data: { is: "subordinated" }, nested: [], context: { element: [ "child", 0 ] } } ], consent: { functional: true }, id: "1741911217000-gr0up-1", trigger: "test", entity: "entity", action: "action", timestamp: 1741911217000, timing: 3.14, group: "gr0up", count: 1, version: { source: "0.0.7", tagging: 1 }, source: { type: "web", id: "https://localhost:80", previous_id: "http://remotehost:9001" } }

Custom Config

{
  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

Follow the Ecommerce revenue tracking guide to setup the purchase event.

Event

{
  event: "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: [
    {
      type: "product",
      data: {
        id: "ers",
        name: "Everyday Ruck Snack",
        color: "black",
        size: "l",
        price: 420
      },
      context: {
        shopping: [
          "complete",
          0
        ]
      },
      nested: []
    },
    {
      type: "product",
      data: {
        id: "cc",
        name: "Cool Cap",
        size: "one size",
        price: 42
      },
      context: {
        shopping: [
          "complete",
          0
        ]
      },
      nested: []
    },
    {
      type: "gift",
      data: {
        name: "Surprise"
      },
      context: {
        shopping: [
          "complete",
          0
        ]
      },
      nested: []
    }
  ],
  consent: {
    functional: true
  },
  id: "1741911217000-gr0up-1",
  trigger: "load",
  entity: "order",
  action: "complete",
  timestamp: 1741911217000,
  timing: 3.14,
  group: "gr0up",
  count: 1,
  version: {
    source: "0.0.7",
    tagging: 1
  },
  source: {
    type: "web",
    id: "https://localhost:80",
    previous_id: "http://remotehost:9001"
  }
}

{ event: "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: [ { type: "product", data: { id: "ers", name: "Everyday Ruck Snack", color: "black", size: "l", price: 420 }, context: { shopping: [ "complete", 0 ] }, nested: [] }, { type: "product", data: { id: "cc", name: "Cool Cap", size: "one size", price: 42 }, context: { shopping: [ "complete", 0 ] }, nested: [] }, { type: "gift", data: { name: "Surprise" }, context: { shopping: [ "complete", 0 ] }, nested: [] } ], consent: { functional: true }, id: "1741911217000-gr0up-1", trigger: "load", entity: "order", action: "complete", timestamp: 1741911217000, timing: 3.14, group: "gr0up", count: 1, version: { source: "0.0.7", tagging: 1 }, source: { type: "web", id: "https://localhost:80", previous_id: "http://remotehost:9001" } }

Custom Config

{
  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.

info

If you need professional support with your walkerOS implementation, check out our services.