# Plausible Analytics

Privacy-focused web analytics platform that provides simple, lightweight, and GDPR-compliant website statistics

- **Category:** analytics
- **Auth:** API_KEY
- **Composio Managed App Available?** N/A
- **Tools:** 14
- **Triggers:** 0
- **Slug:** `PLAUSIBLE_ANALYTICS`
- **Version:** 00000000_00

## Tools

### Check API Health

**Slug:** `PLAUSIBLE_ANALYTICS_CHECK_HEALTH`

Tool to check the health status of the Plausible Analytics API. Use when verifying API connectivity and service availability before making other API calls.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Breakdown Stats

**Slug:** `PLAUSIBLE_ANALYTICS_GET_BREAKDOWN_STATS`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `date` | string | No | 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` | integer | No | Page number for pagination. Use with limit parameter to retrieve results beyond the first page. Starts at 1 |
| `limit` | integer | No | Maximum number of results to return (1-1000). If not specified, returns all available results up to 1000 |
| `period` | string | No | 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` | string | No | 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) |
| `metrics` | string | No | 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 |
| `site_id` | string | Yes | Domain of your site on Plausible (e.g., 'example.com'). This is the site ID as configured in your Plausible account |
| `property` | string | Yes | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Plugin Capabilities

**Slug:** `PLAUSIBLE_ANALYTICS_GET_PLUGIN_CAPABILITIES`

Tool to retrieve available capabilities for the Plausible Analytics Plugins API. Use this to check which features are enabled for the authenticated account, such as Goals, Funnels, Stats API, and more.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Realtime Visitors

**Slug:** `PLAUSIBLE_ANALYTICS_GET_REALTIME_VISITORS`

Tool to retrieve the number of current visitors on your site in the last 5 minutes. Use this to get real-time visitor counts from the Plausible Analytics Stats API v1.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `site_id` | string | Yes | Domain of your site on Plausible (e.g., 'example.com') |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Site Details

**Slug:** `PLAUSIBLE_ANALYTICS_GET_SITE`

Tool to retrieve details for a specific Plausible Analytics site. Use when you need site configuration including domain, timezone, custom properties, and tracker script settings.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `site_id` | string | Yes | Domain/ID of the site to retrieve (e.g., 'example.com' or 'composio') |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Timeseries Stats

**Slug:** `PLAUSIBLE_ANALYTICS_GET_TIMESERIES_STATS`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `period` | string | No | 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'. |
| `filters` | string | No | Filter expression to drill down data. Format: 'property==value' or 'property==value;property2==value2'. Examples: 'event:page==/blog', 'visit:source==Twitter'. |
| `metrics` | string | No | 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. |
| `site_id` | string | Yes | Domain of your site on Plausible (e.g., 'example.com') |
| `interval` | string ("day" | "month") | No | Interval for grouping timeseries data. |
| `with_imported` | boolean | No | Whether to include imported statistics from other analytics platforms. Defaults to false if not specified. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Custom Properties

**Slug:** `PLAUSIBLE_ANALYTICS_LIST_CUSTOM_PROPS`

Tool to list all custom properties configured for a site. Use when you need to retrieve custom property configurations for a Plausible Analytics site. Enterprise feature only.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `site_id` | string | Yes | Domain of the site to retrieve custom properties for. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Goals

**Slug:** `PLAUSIBLE_ANALYTICS_LIST_GOALS`

Tool to list all goals configured for a site. Use when you need to retrieve conversion goals and custom action tracking configured for a Plausible Analytics site.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `site_id` | string | Yes | Domain of the site to retrieve goals for. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Site Guests

**Slug:** `PLAUSIBLE_ANALYTICS_LIST_GUESTS`

Tool to list all guest users who have access to a site's dashboard in Plausible Analytics. Use when you need to see which guests have been granted access to view a specific site's analytics. This is an Enterprise feature.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `site_id` | string | Yes | Domain of the site to list guests for (e.g., 'example.com') |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Sites

**Slug:** `PLAUSIBLE_ANALYTICS_LIST_SITES`

Tool to list all sites the API key owner's Plausible account can access. Returns domain, timezone, and creation info with pagination support. Use when you need to retrieve all sites or paginate through large site lists.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `after` | string | No | Pagination cursor for fetching the next page of results. |
| `limit` | integer | No | Maximum number of sites to return per page. Defaults to 100 if not specified. |
| `before` | string | No | Pagination cursor for fetching the previous page of results. |
| `team_id` | string | No | ID of the team to scope the list of sites by. If provided, only sites belonging to this team will be returned. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Teams

**Slug:** `PLAUSIBLE_ANALYTICS_LIST_TEAMS`

Tool to list all teams available for the API key owner. Use when you need to retrieve teams for site provisioning to a specific team.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `after` | string | No | Pagination cursor for fetching the next page of results. |
| `limit` | integer | No | Maximum number of teams to return per page. Defaults to 100 if not specified. |
| `before` | string | No | Pagination cursor for fetching the previous page of results. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Query Analytics Stats

**Slug:** `PLAUSIBLE_ANALYTICS_QUERY_STATS`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `filters` | array | No | Array of filter conditions to apply to the query. Each filter is an array with format: [dimension, operator, value]. Operators: 'is', 'is_not', 'contains', 'does_not_contain'. Example: [['event:page', 'is', '/blog'], ['visit:country', 'is', 'US']]. |
| `metrics` | array | Yes | 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). |
| `site_id` | string | Yes | Domain of your site on Plausible to be queried (e.g., 'example.com', 'composio'). |
| `date_range` | string | Yes | 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']. |
| `dimensions` | array | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Record Event

**Slug:** `PLAUSIBLE_ANALYTICS_RECORD_EVENT`

Tool to record a pageview or custom event via the Plausible Events API. Use when tracking Android/iOS mobile apps or server-side tracking. Requires proper User-Agent and optionally X-Forwarded-For headers for unique visitor counting.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | Yes | 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` | string | Yes | Name of the event. Use 'pageview' for page views, other names become custom events (e.g., 'signup', 'purchase', 'button_click'). |
| `props` | object | No | Custom properties for the event as key-value pairs (max 30 properties). Values can be strings, numbers, or booleans. |
| `domain` | string | Yes | Domain name of the site in Plausible (e.g., 'example.com'). |
| `revenue` | object | No | Revenue data for the event. |
| `referrer` | string | No | Referrer URL for this event (e.g., 'https://google.com/search'). |
| `user_agent` | string | Yes | Raw User-Agent string for unique visitor identification and device detection. Should be the actual user agent from the client's browser or app. |
| `interactive` | boolean | No | Whether the event counts towards bounce rate. Default is true. Set to false for non-interactive events like automatic tracking. |
| `x_forwarded_for` | string | No | 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. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |
