Skip to main content

Events API reference

The Plausible Events API can be used to record pageviews and custom events. This is useful when tracking Android or iOS mobile apps, or for server side tracking.

In most cases we recommend installing Plausible through our provided script or one of the many integration packages listed here. However, if there's no easy way for you to integrate with Plausible, you can still do so by sending events directly to our API.

Unique visitor tracking​

Important! Special care should be taken with two key headers which are used for unique visitor counting:

  1. The User-Agent header
  2. The X-Forwarded-For header

If these headers are not sent exactly as required, unique visitor counting will not work as intended. Please refer to the Request headers section below for more in-depth documentation on each header separately.

Endpoints​

POST /api/event​

Records a pageview or custom event. When using this endpoint, it's crucial to send the HTTP headers correctly, since these are used for unique user counting.

Try it yourself
curl -i -X POST https://plausible.io/api/event \
  -H 'User-Agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_6) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/85.0.4183.121 Safari/537.36 OPR/71.0.3770.284' \
  -H 'X-Forwarded-For: 127.0.0.1' \
  -H 'Content-Type: application/json' \
  --data '{"name":"pageview","url":"http://dummy.site","domain":"dummy.site"}'
Response 202 Accepted
{}

Request headers​

User-Agent REQUIRED

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.

The header is required but bear in mind that browsers and some HTTP libraries automatically add a default User-Agent header to HTTP requests. In case of browsers, we would not recommend overriding the header manually unless you have a specific reason to.

X-Forwarded-For optional

Used to explicitly set the IP address of the client. If not set, the remote IP of the sender will automatically be used. Depending on your use-case:

  1. If sending the event from your visitors' device, this header does not need to be set
  2. If sending the event from a backend server or proxy, make sure to override this header with the correct IP address of the client.

The raw value of the IP address is not stored in our database. The IP address is used to calculate the user_id which identifies a unique visitor in Plausible. It is also used to fill the Location report with country, region and city data of the visitor.

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. Both IPv4 and IPv6 addresses are supported. More information about the header format can be found on MDN docs.

Content-Type REQUIRED

Must be either application/json or text/plain. In case of text/plain, the request body is still interpreted as JSON.

Request body JSON parameters​

domain REQUIRED

Domain name of the site in Plausible

This is the domain name you used when you added your site to your Plausible account

It doesn't need to be an actual domain name, so when adding your mobile app to Plausible, you could insert the mobile app name in the domain name field

name REQUIRED

Name of the event. Can specify pageview which is a special type of event in Plausible. All other names will be treated as custom events.

url REQUIRED

URL of the page where the event was triggered. If the URL contains UTM parameters, they will be extracted and stored. When using the script, this is set to window.location.href.

The hostname derived from url takes part in unique visitor recognition.

Sending two events from the same client, for two different hostnames, will result with two sessions recorded. If you don't include hostname in the url field (e.g. the value is /blog instead of https://example.com/blog), we'll store missing hostname as (none).

The maximum size of the URL, excluding the domain and the query string, is 2,000 characters. Additionally, URLs using the data URI scheme are not supported by the API.

The URL parameter will feel strange in a mobile app but you can manufacture something that looks like a web URL

If you name your mobile app screens like page URLs, Plausible will know how to handle it. So for example, on your login screen you could send something like:

event: pageview url: app://localhost/login

The pathname (/login) is what will be shown as the page value in the Plausible dashboard

referrer optional

Referrer for this event. When using the standard tracker script, this is set to document.referrer

Referrer values are processed heavily for better usability. Consider referrer URLS like m.facebook.com/some-path and facebook.com/some-other-path. It's intuitive to think of both of these as coming from a single source: Facebook. In the first example the referrer value would be split into visit:source == Facebook and visit:referrer == m.facebook.com/some-path.

Plausible uses the open source referer-parser database to parse referrers and assign these source categories.

When no match has been found, the value of the referrer field will be parsed as an URL. The hostname will be used as the visit:source and the full URL as the visit:referrer. So if you send https://some.domain.com/example-path, it will be parsed as follows: visit:source == some.domain.com visit:referrer == some.domain.com/example-path

props optional

Custom properties for the event. These can be attached to both pageviews and custom events. Learn more about using custom properties here.

The value corresponding to the props key in the request body is expected to be a JSON object with a maximum of 30 key-value pairs. If you include more than 30 items in the props object, the exceeding items will be discarded. For example, if you're using the text/plain content type, your request body might look like this:

'{"name":"pageview","url":"http://dummy.site","domain":"dummy.site","props":{"author":"John Doe","logged_in":"false"}}'

revenue optional

Revenue data for this event. This can be attached to goals and custom events to track revenue attribution. To learn more about revenue tracking and how you can set up your dashboard before sending revenue data, please read this document.

The value corresponding to the revenue key in the request body is expected to be a JSON object with currency and amount. currency is a ISO 4217 string representing the currency code, e.g. "USD" or "EUR". amount can be either a float or a string, e.g. 1322.22 or "1322.22". In the case of an invalid currency or amount, the event is still recorded and the API returns HTTP 202, but revenue data associated with it is discarded.

For example, to track a purchase of US$ 1.322,22, your request body might look like this:

{"name":"Purchase","url":"http://dummy.site","domain":"dummy.site","revenue":{"currency":"USD","amount":"1322.22"}}

interactive optional

Whether the event is interactive. By default, Plausible will assume all events are interactive and will be counted for bounce detection.

By marking a custom event as non-interactive, it will not be counted towards bounce rate calculations.

Debugging​

By default, the API returns HTTP 202 Accepted. However, if you want to debug a request and see if the X-Forwarded-For header is set correctly, you can add the X-Debug-Request header to your request. If set to true, the API will return an HTTP 200 OK and the IP address which we will use for unique visitor counting.

E.g: Add this header to your request and log the response.

Want to monitor the status of our API?

You can can use GET https://plausible.io/api/health endpoint to do so