Plausible Analytics

Parámetros de entrada

Sin parámetros.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• periodstring

  Time period for aggregation. Examples: '6mo' (6 months), '12mo' (12 months), '30d' (30 days), 'day' (today), 'month' (current month). If not specified, defaults to '30d'.

• comparestring

  Comparison mode for showing period-over-period changes. Use 'previous_period' to compare with the previous equivalent time period.

• filtersstring

  Filter expression to drill down data. Format: 'property==value' or 'property==value;property2==value2'. Examples: 'event:page==/blog', 'visit:source==Twitter'.

• metricsstring

  Comma-separated list of metrics to aggregate. Valid options: 'visitors', 'visits', 'pageviews', 'views_per_visit', 'bounce_rate', 'visit_duration', 'events', 'conversion_rate', 'time_on_page'. Defaults to 'visitors' if not specified.

• site_idstringObligatorio

  Domain of your site on Plausible (e.g., 'example.com')

• with_importedboolean

  Whether to include imported statistics from other analytics platforms. Defaults to false if not specified.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• datestring

  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

• pageinteger

  Page number for pagination. Use with limit parameter to retrieve results beyond the first page. Starts at 1

• limitinteger

  Maximum number of results to return (1-1000). If not specified, returns all available results up to 1000

• periodstring

  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'

• filtersstring

  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)

• metricsstring

  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_idstringObligatorio

  Domain of your site on Plausible (e.g., 'example.com'). This is the site ID as configured in your Plausible account

• propertystringObligatorio

  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

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

Sin parámetros.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• site_idstringObligatorio

  Domain of your site on Plausible (e.g., 'example.com')

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• site_idstringObligatorio

  Domain/ID of the site to retrieve (e.g., 'example.com' or 'composio')

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• periodstring

  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'.

• filtersstring

  Filter expression to drill down data. Format: 'property==value' or 'property==value;property2==value2'. Examples: 'event:page==/blog', 'visit:source==Twitter'.

• metricsstring

  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_idstringObligatorio

  Domain of your site on Plausible (e.g., 'example.com')

• intervalstringenum

  Interval for grouping timeseries data.

  daymonth
• with_importedboolean

  Whether to include imported statistics from other analytics platforms. Defaults to false if not specified.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• site_idstringObligatorio

  Domain of the site to retrieve custom properties for.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• site_idstringObligatorio

  Domain of the site to retrieve goals for.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• site_idstringObligatorio

  Domain of the site to list guests for (e.g., 'example.com')

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• afterstring

  Pagination cursor for fetching the next page of results.

• limitinteger

  Maximum number of sites to return per page. Defaults to 100 if not specified.

• beforestring

  Pagination cursor for fetching the previous page of results.

• team_idstring

  ID of the team to scope the list of sites by. If provided, only sites belonging to this team will be returned.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• afterstring

  Pagination cursor for fetching the next page of results.

• limitinteger

  Maximum number of teams to return per page. Defaults to 100 if not specified.

• beforestring

  Pagination cursor for fetching the previous page of results.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• filtersarray[]

  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']].

• metricsstring[]Obligatorio

  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_idstringObligatorio

  Domain of your site on Plausible to be queried (e.g., 'example.com', 'composio').

• date_rangeanyObligatorio

  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'].

• dimensionsstring[]

  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'.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• urlstringObligatorio

  URL of the page where the event was triggered. UTM parameters will be automatically extracted (e.g., 'https://example.com/page?utm_source=google').

• namestringObligatorio

  Name of the event. Use 'pageview' for page views, other names become custom events (e.g., 'signup', 'purchase', 'button_click').

• propsobject

  Custom properties for the event as key-value pairs (max 30 properties). Values can be strings, numbers, or booleans.

• domainstringObligatorio

  Domain name of the site in Plausible (e.g., 'example.com').

• revenueobject

  Revenue data for the event.

• referrerstring

  Referrer URL for this event (e.g., 'https://google.com/search').

• user_agentstringObligatorio

  Raw User-Agent string for unique visitor identification and device detection. Should be the actual user agent from the client's browser or app.

• interactiveboolean

  Whether the event counts towards bounce rate. Default is true. Set to false for non-interactive events like automatic tracking.

• x_forwarded_forstring

  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.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not