list_guests
List Guests
List all guest users for a site, including their email, role (viewer or editor), and invitation status. Requires a Sites API key (Enterprise plan).
list_guests
List all guest users for a site, including their email, role (viewer or editor), and invitation status. Requires a Sites API key (Enterprise plan).
create_custom_property
Create a custom property for a site. This endpoint is idempotent — creating a property that already exists will not fail. Requires a Sites API key (Enterprise plan).
delete_custom_property
Delete a custom property from a site. Requires a Sites API key (Enterprise plan).
list_teams
List teams associated with your Plausible Analytics account and check whether API access is available for each team. Requires a Sites API key (Enterprise plan).
update_site
Update an existing site in Plausible Analytics. Can change the domain name and/or update tracker script configuration. Requires a Sites API key (Enterprise plan).
delete_site
Delete a site from your Plausible Analytics account along with all its data. Data removal may take up to 48 hours. Requires a Sites API key (Enterprise plan).
create_site
Create a new site in your Plausible Analytics account. Configure the domain, timezone, and tracker script options. Requires a Sites API key (Enterprise plan).
delete_goal
Delete a conversion goal from a site. Requires a Sites API key (Enterprise plan).
query_analytics
Query website analytics data from Plausible. Supports metrics like visitors, pageviews, bounce rate, visit duration, and revenue. Data can be broken down by dimensions such as page, traffic source, country, device, browser, OS, and UTM parameters. Supports configurable date ranges and time-series output.
create_shared_link
Create or find a shared link for a site to enable public or embedded dashboard access. This endpoint is idempotent — requesting an existing link name returns the existing link. Requires a Sites API key (Enterprise plan).
get_site
Get details of a specific site including its tracker script configuration and custom properties. Requires a Sites API key (Enterprise plan).
invite_guest
Invite a guest user to access a site's analytics dashboard. Guests can be assigned a viewer or editor role. Requires a Sites API key (Enterprise plan).
remove_guest
Remove a guest user's access from a site. Requires a Sites API key (Enterprise plan).
list_sites
List all sites accessible from your Plausible Analytics account. Supports pagination and filtering by team. Requires a Sites API key (Enterprise plan).
get_realtime_visitors
Get the current number of visitors on your website in real time. Returns a single count of active visitors within the last 5 minutes.
list_custom_properties
List all custom properties configured for a site. Custom properties allow capturing additional metadata with events (e.g., author, category, logged-in status). Requires a Sites API key (Enterprise plan).
send_event
Send a pageview or custom event to Plausible Analytics. Useful for server-side tracking, mobile apps, or environments where the JavaScript tracker cannot be used. No API key is required — authentication is based on the domain matching a registered site.
create_goal
Create or find a conversion goal for a site. Goals can be either pageview goals (triggered when a specific page is visited) or custom event goals (triggered when a named event fires). This endpoint is idempotent — creating a goal that already exists returns the existing one. Requires a Sites API key (Enterprise plan).
list_goals
List all conversion goals configured for a site. Returns both pageview and custom event goals. Requires a Sites API key (Enterprise plan).
Query privacy-friendly website analytics data including visitors, pageviews, bounce rate, visit duration, and revenue metrics. Break down data by dimensions such as page, traffic source, country, device, browser, UTM parameters, and custom properties. Send pageviews and custom events programmatically for server-side or app tracking. Manage sites, goals (conversion tracking), custom properties, shared dashboard links, and guest user access. Filter analytics with operators like is, contains, and session-level filters. Supports configurable date ranges and time-series output.
Common questions about connecting Plausible Analytics to AI agents with Metorial.