- Category: analytics
- Auth: API_KEY
- Composio-managed OAuth available? N/A
- Tools: 13
- Triggers: 0
- Slug:
PLAUSIBLE_ANALYTICS - Version: 20261101_00
Tools
Check API Health
Check API Health
Get Breakdown Stats
Get Breakdown Stats
Slug:
PLAUSIBLE_ANALYTICS_GET_BREAKDOWN_STATSTool to retrieve breakdown statistics for a specific property (dimension) from Plausible Analytics. Use when you need to analyze top sources, top pages, device breakdown, geographic distribution, or any other dimensional breakdown of your site traffic. This is a legacy Stats API v1 endpoint used for Top Sources, Top Pages and similar reports.Input Parameters
Date for period context or custom date range. For ‘custom’ period, use two ISO-8601 dates separated by comma (e.g., ‘2023-01-01,2023-01-31’). For other periods, single date in YYYY-MM-DD format to anchor the period
Page number for pagination. Use with limit parameter to retrieve results beyond the first page. Starts at 1
Maximum number of results to return (1-1000). If not specified, returns all available results up to 1000
Time period for stats. Valid values: ‘12mo’ (last 12 months), ‘6mo’ (last 6 months), ‘month’ (current month), ‘30d’ (last 30 days), ‘7d’ (last 7 days), ‘day’ (current day), ‘custom’ (custom range using date parameter with two ISO-8601 dates separated by comma). Defaults to ‘30d’
Filters to apply to the query. Format: ‘property==value’ or ‘property==value;property2==value2’. Use semicolon to separate multiple filters. Supports operators: == (equals), != (not equals), ~ (contains), !~ (does not contain)
Comma-separated list of metrics to include. Available metrics: visitors (unique visitors), visits (total visits), pageviews (total page views), views_per_visit, bounce_rate (percentage), visit_duration (seconds), events (total events), conversion_rate (percentage), time_on_page (seconds). If not specified, only the visitor count for each breakdown value is returned
Domain of your site on Plausible (e.g., ‘example.com’). This is the site ID as configured in your Plausible account
Property to break down by. Supported values: event:page, event:goal, visit:source, visit:referrer, visit:utm_medium, visit:utm_source, visit:utm_campaign, visit:utm_content, visit:utm_term, visit:device, visit:browser, visit:browser_version, visit:os, visit:os_version, visit:country, visit:region, visit:city, visit:entry_page, visit:exit_page, or event:props:<custom_prop_name> for custom properties
Output
Get Plugin Capabilities
Get Plugin Capabilities
Get Realtime Visitors
Get Realtime Visitors
Get Site Details
Get Site Details
Get Timeseries Stats
Get Timeseries Stats
Slug:
PLAUSIBLE_ANALYTICS_GET_TIMESERIES_STATSTool to retrieve timeseries visitor data from Plausible Analytics over a specified time period. Use this to get historical trends for metrics like visitors, pageviews, bounce rate, and visit duration. This is the legacy Stats API v1 endpoint typically used for the main visitor graph.Input Parameters
Time period for the timeseries data. Examples: ‘6mo’ (6 months), ‘12mo’ (12 months), ‘30d’ (30 days), ‘day’ (today), ‘month’ (current month). If not specified, defaults to ‘30d’.
Filter expression to drill down data. Format: ‘property==value’ or ‘property==value;property2==value2’. Examples: ‘event:page==/blog’, ‘visit:source==Twitter’.
Comma-separated list of metrics to show for each time bucket. Valid options: ‘visitors’, ‘visits’, ‘pageviews’, ‘views_per_visit’, ‘bounce_rate’, ‘visit_duration’, ‘events’, ‘conversion_rate’. Defaults to ‘visitors’ if not specified.
Whether to include imported statistics from other analytics platforms. Defaults to false if not specified.
Output
List Custom Properties
List Custom Properties
List Goals
List Goals
Slug:
PLAUSIBLE_ANALYTICS_LIST_GOALSLists a page of conversion goals and custom action tracking configured for a Plausible Analytics site, with cursor pagination.Input Parameters
Pagination cursor for fetching the next page of results. Use the ‘after’ value from a previous response’s meta.
Pagination cursor for fetching the previous page of results. Use the ‘before’ value from a previous response’s meta.
Output
List Site Guests
List Site Guests
List Sites
List Sites
List Teams
List Teams
Query Analytics Stats
Query Analytics Stats
Slug:
PLAUSIBLE_ANALYTICS_QUERY_STATSTool to query analytics stats for a site using the Stats API v2. Use when you need to retrieve historical or real-time statistics such as visitors, pageviews, bounce rate, visit duration, and more. Supports filtering, grouping by dimensions, and custom date ranges.Input Parameters
Simple filter conditions in Plausible’s [operator, dimension, clauses] format. Clauses must be a non-empty list of strings. Operators: ‘is’, ‘is_not’, ‘contains’, ‘contains_not’, ‘matches’, ‘matches_not’. The ‘event:goal’ dimension only supports ‘is’ and ‘contains’.
List of metrics to calculate. Available metrics: ‘visitors’ (unique visitors), ‘visits’ (total visits), ‘pageviews’ (total page views), ‘views_per_visit’ (average pages per visit), ‘bounce_rate’ (percentage of single-page visits), ‘visit_duration’ (average visit duration in seconds), ‘events’ (total events), ‘scroll_depth’ (average scroll depth percentage), ‘percentage’ (percentage of total), ‘conversion_rate’, ‘group_conversion_rate’, ‘average_revenue’, ‘total_revenue’, ‘time_on_page’ (average time on page in seconds). ‘conversion_rate’ and ‘group_conversion_rate’ require an ‘event:goal’ filter or dimension.
Date range to query. Use predefined periods: ‘day’ (today), ‘7d’ (last 7 days), ‘30d’ (last 30 days), ‘month’ (current month), ‘6mo’ (last 6 months), ‘12mo’ (last 12 months), ‘year’ (current year), ‘all’ (all time), or custom ISO8601 date array like [‘2024-01-01’, ‘2024-01-31’].
List of dimensions to group results by. Common dimensions: ‘event:goal’ (goal names), ‘event:page’ (page paths), ‘event:hostname’ (hostnames), ‘visit:source’ (traffic sources), ‘visit:referrer’ (referrer URLs), ‘visit:utm_medium’, ‘visit:utm_source’, ‘visit:utm_campaign’, ‘visit:device’ (device types), ‘visit:browser’, ‘visit:os’ (operating systems), ‘visit:country’, ‘visit:region’, ‘visit:city’.
Output
Record Event
Record Event
Slug:
PLAUSIBLE_ANALYTICS_RECORD_EVENTSends a pageview or custom event to the Plausible Events API for mobile or server-side tracking, using the visitor’s User-Agent and, when forwarding from a backend, visitor IP. A success response does not guarantee the event was recorded.Input Parameters
URL of the page where the event was triggered. UTM parameters will be automatically extracted (e.g., ‘https://example.com/page?utm_source=google’).
Name of the event. Use ‘pageview’ for page views, other names become custom events (e.g., ‘signup’, ‘purchase’, ‘button_click’).
Custom properties for the event as key-value pairs (max 30 properties). Values can be strings, numbers, or booleans.
Referrer URL for this event (e.g., ‘https://google.com/search’).
Raw User-Agent string for unique visitor identification and device detection. Should be the actual user agent from the client’s browser or app.
Whether the event counts towards bounce rate. Default is true. Set to false for non-interactive events like automatic tracking.
IP address of the client for unique visitor counting and location data (e.g., ‘203.0.113.195’). If not provided, the server’s IP will be used.