← Tools Reference

Plausible Analytics

Plausible Analytics integration (Data, Marketing). Imported from open-connector.

API key4 tools{base_url}
POST
plausible_analytics_query_stats
Query historical or real-time analytics for a Plausible site using the Stats API v2.

/api/v2/query

8 parameters
ParamTypeRequiredDescription
site_idstringoptionalSite identifier in Plausible. When omitted, the provider falls back to the defa…
date_rangestringrequiredDate range to query, such as '7d', '30d', 'month', or a custom [from, to] ISO d…
metricsarrayrequiredMetrics to calculate for the query.
filtersarrayoptionalPlausible filter expression array passed through to the Stats API.
order_byarrayoptionalPlausible order_by expression array passed through to the Stats API.
includeobjectoptionalOptional include flags supported by the Plausible Stats API.
paginationobjectoptionalPagination options passed through to the Plausible Stats API.
dimensionsarrayoptionalDimensions to group the query results by.
POST
plausible_analytics_get_timeseries_stats
Query Plausible analytics as a timeseries grouped by a time dimension such as day or hour.

/api/v2/query

8 parameters
ParamTypeRequiredDescription
site_idstringoptionalSite identifier in Plausible. When omitted, the provider falls back to the defa…
date_rangestringrequiredDate range to query, such as '7d', '30d', 'month', or a custom [from, to] ISO d…
metricsarrayrequiredMetrics to calculate for the query.
filtersarrayoptionalPlausible filter expression array passed through to the Stats API.
order_byarrayoptionalPlausible order_by expression array passed through to the Stats API.
includeobjectoptionalOptional include flags supported by the Plausible Stats API.
paginationobjectoptionalPagination options passed through to the Plausible Stats API.
intervalstringrequiredTime dimension used to build a timeseries query.
POST
plausible_analytics_get_breakdown_stats
Query Plausible analytics grouped by a single dimension such as source, page, country, or browser.

/api/v2/query

8 parameters
ParamTypeRequiredDescription
site_idstringoptionalSite identifier in Plausible. When omitted, the provider falls back to the defa…
date_rangestringrequiredDate range to query, such as '7d', '30d', 'month', or a custom [from, to] ISO d…
metricsarrayrequiredMetrics to calculate for the query.
filtersarrayoptionalPlausible filter expression array passed through to the Stats API.
order_byarrayoptionalPlausible order_by expression array passed through to the Stats API.
includeobjectoptionalOptional include flags supported by the Plausible Stats API.
paginationobjectoptionalPagination options passed through to the Plausible Stats API.
dimensionstringrequiredDimension identifier accepted by the Plausible Stats API.
POST
plausible_analytics_record_event
Record a pageview or custom event through the Plausible Events API for server-side or app tracking.

/api/event

10 parameters
ParamTypeRequiredDescription
domainstringoptionalSite identifier used by Plausible for the event. When omitted, the provider fal…
namestringrequiredEvent name. Use 'pageview' for a pageview event or any custom event name.
urlstringrequiredAbsolute URL of the page or screen where the event happened.
referrerstringoptionalReferrer URL to associate with the event.
propsobjectoptionalCustom event properties to attach to the recorded event.
revenueobjectoptionalAction input.
interactivebooleanoptionalWhether the event should count as interactive for bounce calculations.
userAgentstringoptionalCustom User-Agent header to send with the event request.
forwardedForstringoptionalIP address or X-Forwarded-For chain to send with the event request.
debugRequestbooleanoptionalWhether to enable Plausible debug mode with the X-Debug-Request header.