pixellint

vendor/plausible · vendor documented

Plausible events need name, url, and domain

POST JSON to /api/event. name is pageview or a custom event. url is the absolute page URL. domain is the site as configured in Plausible. Self-hosted collectors stay attributed.

What this pack matches

Hosts
plausible.io
Paths
/api/event
Vendor docs
plausible.io/docs/events-api

Rules

Codes are stable. A finding in CI, MCP, or the playground lands on the same id.

Field Required What it checks Rule ids Source
name optional It is the event name. `pageview` is the special page-view event; any other value is a custom event. The tracker also sends this as `n`. Fix: Set `name` to `pageview` or to a custom event name. vendor.plausible.body.name.empty docs
n optional Short key for `name`, used by the JavaScript tracker. Fix: Set `n` or `name` to the event name. vendor.plausible.body.n.empty docs
url optional It is the page URL where the event fired. Plausible documents it as required and extracts UTM parameters from it. The tracker also sends this as `u`. Fix: Set `url` to an absolute URL, including the scheme and host. vendor.plausible.body.url.empty
vendor.plausible.body.url.invalid
docs
u optional Short key for `url`, used by the JavaScript tracker. Fix: Set `u` or `url` to an absolute page URL. vendor.plausible.body.u.empty
vendor.plausible.body.u.invalid
docs
domain optional It is the site domain as configured in the Plausible account. The tracker also sends this as `d`. Fix: Set `domain` to the domain you added in Plausible, such as `example.com`. vendor.plausible.body.domain.empty docs
d optional Short key for `domain`, used by the JavaScript tracker. Fix: Set `d` or `domain` to the Plausible site domain. vendor.plausible.body.d.empty docs
event_name_required required The event has neither `name` nor `n`. Plausible documents `name` as required. Fix: Set `name` (or `n`) to `pageview` or to a custom event name. vendor.plausible.event_name_required docs
page_url_required required The event has neither `url` nor `u`. Plausible documents `url` as required. Fix: Set `url` (or `u`) to an absolute page URL. vendor.plausible.page_url_required docs
domain_required required The event has neither `domain` nor `d`. Plausible documents `domain` as required. Fix: Set `domain` (or `d`) to the site domain configured in Plausible. vendor.plausible.domain_required docs

Validate a payload

pixellint validate json @payload.json --rulepack vendor/plausible

Try this failing payload in the playground. Plausible event with an empty name.

{"name":"","url":"https://example.com/pricing","domain":"example.com"}

cargo install pixellint · npm install pixellint