Pirsch Analytics MCP by usefulapi

Server Details

Read Pirsch web analytics: visitors, pages, referrers, UTM, events, funnels and sessions.

If you are the author of this connector, you can claim ownership by verifying the domain or GitHub account it belongs to. Claimed connector authors can inspect health checks, view analytics, and manage their listing.

Status: Healthy
Last Tested: 2026-10-10 20:18
Transport: Streamable HTTP · MCP 2025-06-18
URL
Repository: m190/usefulapi-mcp
GitHub Stars: 0

TDQS

Score is being calculated.

Available Tools

27 tools

pirsch_get_active_visitorsGet active visitors

Read-only

Inspect

Visitors on the site right now (or in the past n seconds), with the pages they are on and their countries. GET /api/v1/statistics/active.

ParametersJSON Schema

Name	Required	Description	Default
`start`	No	Look back this many seconds, 1-3600 (default 600 = 10 minutes).
`domain_id`	Yes	Pirsch domain (dashboard) id. Get it from pirsch_list_domains.

pirsch_get_domainGet domain

Read-only

Inspect

One Pirsch dashboard (domain) by id, with its time zone, hostname, role and subscription state. GET /api/v1/domain?id=.

ParametersJSON Schema

Name	Required	Description	Default
`domain_id`	Yes	Pirsch domain (dashboard) id. Get it from pirsch_list_domains.

pirsch_get_durationGet time spent

Read-only

Inspect

Average session duration over time, or average time on page over time, in seconds. GET /api/v1/statistics/duration/session or /duration/page.

ParametersJSON Schema

Name	Required	Description
`os`	No	Operating system. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`to`	Yes	Last day, yyyy-mm-dd, whole day included.
`tz`	No	IANA time zone such as Europe/Berlin. Default: the dashboard's time zone.
`tag`	No	Tag key to filter for.
`city`	No	City name. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`from`	Yes	First day, yyyy-mm-dd (in the dashboard time zone unless tz is set).
`kind`	Yes	session = average session duration, page = average time on page.
`path`	No	Page path, for example /pricing. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`tags`	No	Tag key/value pairs; only results with all pairs match.
`event`	No	Event name. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`scale`	No	Group results by day (default), week, month or year.
`browser`	No	Browser. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`channel`	No	Traffic channel such as "Paid Search" or "Organic Search". Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`country`	No	ISO 3166 alpha-2 country code such as jp. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`pattern`	No	Regular expression that filters and groups pages, for example (?i)^/blog/[^/]+$.
`hostname`	No	Hostname (useful for rollup views). Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`language`	No	ISO 639-1 language code such as en. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`platform`	No	Platform.
`referrer`	No	Referrer, usually a URL. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`utm_term`	No	UTM term. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`domain_id`	Yes	Pirsch domain (dashboard) id. Get it from pirsch_list_domains.
`exit_path`	No	Exit page path. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`entry_path`	No	Entry page path. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`event_meta`	No	Event metadata key/value pairs; only events with all pairs match.
`utm_medium`	No	UTM medium. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`utm_source`	No	UTM source. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`utm_content`	No	UTM content. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`screen_class`	No	Screen class XXL, XL, L, M or S. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`utm_campaign`	No	UTM campaign. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`referrer_name`	No	Referrer name, usually the hostname. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).

pirsch_get_event_breakdownGet event metadata breakdown

Read-only

Inspect

The values of one metadata key of one event, with count, visitors and conversion rate. Both event and event_meta_key are required. GET /api/v1/statistics/event/meta.

ParametersJSON Schema

Name	Required	Description
`to`	Yes	Last day, yyyy-mm-dd, whole day included.
`tz`	No	IANA time zone such as Europe/Berlin. Default: the dashboard's time zone.
`from`	Yes	First day, yyyy-mm-dd (in the dashboard time zone unless tz is set).
`sort`	No	Field to sort by, for example visitors, views, sessions or bounce_rate.
`event`	Yes	Event name.
`limit`	No	Results per page, 1-100 (default 25).
`offset`	No	Results to skip (default 0). Pass the previous reply's next_offset.
`search`	No	Only rows whose main field contains this text.
`direction`	No	Sort direction.
`domain_id`	Yes	Pirsch domain (dashboard) id. Get it from pirsch_list_domains.
`event_meta_key`	Yes	Metadata key to break down.

pirsch_get_funnelGet funnel statistics

Read-only

Inspect

Visitors per funnel step for a period: visitors, share of the first step, drop-off between steps. The filter applies to the first step. GET /api/v1/statistics/funnel.

ParametersJSON Schema

Name	Required	Description
`os`	No	Operating system. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`to`	Yes	Last day, yyyy-mm-dd, whole day included.
`tz`	No	IANA time zone such as Europe/Berlin. Default: the dashboard's time zone.
`tag`	No	Tag key to filter for.
`city`	No	City name. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`from`	Yes	First day, yyyy-mm-dd (in the dashboard time zone unless tz is set).
`path`	No	Page path, for example /pricing. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`tags`	No	Tag key/value pairs; only results with all pairs match.
`event`	No	Event name. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`browser`	No	Browser. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`channel`	No	Traffic channel such as "Paid Search" or "Organic Search". Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`country`	No	ISO 3166 alpha-2 country code such as jp. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`pattern`	No	Regular expression that filters and groups pages, for example (?i)^/blog/[^/]+$.
`hostname`	No	Hostname (useful for rollup views). Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`language`	No	ISO 639-1 language code such as en. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`platform`	No	Platform.
`referrer`	No	Referrer, usually a URL. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`utm_term`	No	UTM term. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`domain_id`	Yes	Pirsch domain (dashboard) id. Get it from pirsch_list_domains.
`exit_path`	No	Exit page path. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`funnel_id`	Yes	Funnel id from pirsch_list_funnels.
`entry_path`	No	Entry page path. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`event_meta`	No	Event metadata key/value pairs; only events with all pairs match.
`utm_medium`	No	UTM medium. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`utm_source`	No	UTM source. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`utm_content`	No	UTM content. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`screen_class`	No	Screen class XXL, XL, L, M or S. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`utm_campaign`	No	UTM campaign. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`referrer_name`	No	Referrer name, usually the hostname. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).

pirsch_get_growthGet growth rates

Read-only

Inspect

Growth of visitors, views, sessions, bounces, time spent and conversion rate compared with the previous period of the same length. GET /api/v1/statistics/growth.

ParametersJSON Schema

Name	Required	Description
`os`	No	Operating system. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`to`	Yes	Last day, yyyy-mm-dd, whole day included.
`tz`	No	IANA time zone such as Europe/Berlin. Default: the dashboard's time zone.
`tag`	No	Tag key to filter for.
`city`	No	City name. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`from`	Yes	First day, yyyy-mm-dd (in the dashboard time zone unless tz is set).
`path`	No	Page path, for example /pricing. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`tags`	No	Tag key/value pairs; only results with all pairs match.
`event`	No	Event name. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`browser`	No	Browser. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`channel`	No	Traffic channel such as "Paid Search" or "Organic Search". Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`country`	No	ISO 3166 alpha-2 country code such as jp. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`pattern`	No	Regular expression that filters and groups pages, for example (?i)^/blog/[^/]+$.
`hostname`	No	Hostname (useful for rollup views). Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`language`	No	ISO 639-1 language code such as en. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`platform`	No	Platform.
`referrer`	No	Referrer, usually a URL. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`utm_term`	No	UTM term. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`domain_id`	Yes	Pirsch domain (dashboard) id. Get it from pirsch_list_domains.
`exit_path`	No	Exit page path. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`entry_path`	No	Entry page path. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`event_meta`	No	Event metadata key/value pairs; only events with all pairs match.
`utm_medium`	No	UTM medium. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`utm_source`	No	UTM source. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`utm_content`	No	UTM content. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`screen_class`	No	Screen class XXL, XL, L, M or S. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`utm_campaign`	No	UTM campaign. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`referrer_name`	No	Referrer name, usually the hostname. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).

pirsch_get_overviewGet overview

Read-only

Inspect

Quick overview of a dashboard: visitors, views, growth compared with the previous period, a visitors time series and the number of team members. Cached by Pirsch; takes no date range or filters. GET /api/v1/statistics/overview.

ParametersJSON Schema

Name	Required	Description	Default
`domain_id`	Yes	Pirsch domain (dashboard) id. Get it from pirsch_list_domains.

pirsch_get_platformsGet platform split

Read-only

Inspect

Visitors on desktop, mobile and unknown platforms, as counts and shares. GET /api/v1/statistics/platform.

ParametersJSON Schema

Name	Required	Description
`os`	No	Operating system. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`to`	Yes	Last day, yyyy-mm-dd, whole day included.
`tz`	No	IANA time zone such as Europe/Berlin. Default: the dashboard's time zone.
`tag`	No	Tag key to filter for.
`city`	No	City name. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`from`	Yes	First day, yyyy-mm-dd (in the dashboard time zone unless tz is set).
`path`	No	Page path, for example /pricing. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`tags`	No	Tag key/value pairs; only results with all pairs match.
`event`	No	Event name. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`browser`	No	Browser. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`channel`	No	Traffic channel such as "Paid Search" or "Organic Search". Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`country`	No	ISO 3166 alpha-2 country code such as jp. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`pattern`	No	Regular expression that filters and groups pages, for example (?i)^/blog/[^/]+$.
`hostname`	No	Hostname (useful for rollup views). Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`language`	No	ISO 639-1 language code such as en. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`platform`	No	Platform.
`referrer`	No	Referrer, usually a URL. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`utm_term`	No	UTM term. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`domain_id`	Yes	Pirsch domain (dashboard) id. Get it from pirsch_list_domains.
`exit_path`	No	Exit page path. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`entry_path`	No	Entry page path. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`event_meta`	No	Event metadata key/value pairs; only events with all pairs match.
`utm_medium`	No	UTM medium. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`utm_source`	No	UTM source. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`utm_content`	No	UTM content. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`screen_class`	No	Screen class XXL, XL, L, M or S. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`utm_campaign`	No	UTM campaign. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`referrer_name`	No	Referrer name, usually the hostname. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).

pirsch_get_sessionGet session details

Read-only

Inspect

All page views and events of one session in time order. Both ids come from pirsch_list_sessions. GET /api/v1/statistics/session/details.

ParametersJSON Schema

Name	Required	Description
`to`	Yes	Last day, yyyy-mm-dd, whole day included.
`tz`	No	IANA time zone such as Europe/Berlin. Default: the dashboard's time zone.
`from`	Yes	First day, yyyy-mm-dd (in the dashboard time zone unless tz is set).
`domain_id`	Yes	Pirsch domain (dashboard) id. Get it from pirsch_list_domains.
`session_id`	Yes	session_id from pirsch_list_sessions.
`visitor_id`	Yes	visitor_id from pirsch_list_sessions.

pirsch_get_tag_breakdownGet tag breakdown

Read-only

Inspect

The values of one tag key with views and share. The tag filter (the key) is required. GET /api/v1/statistics/tag/details.

ParametersJSON Schema

Name	Required	Description
`to`	Yes	Last day, yyyy-mm-dd, whole day included.
`tz`	No	IANA time zone such as Europe/Berlin. Default: the dashboard's time zone.
`tag`	Yes	Tag key to break down.
`from`	Yes	First day, yyyy-mm-dd (in the dashboard time zone unless tz is set).
`sort`	No	Field to sort by, for example visitors, views, sessions or bounce_rate.
`limit`	No	Results per page, 1-100 (default 25).
`offset`	No	Results to skip (default 0). Pass the previous reply's next_offset.
`search`	No	Only rows whose main field contains this text.
`direction`	No	Sort direction.
`domain_id`	Yes	Pirsch domain (dashboard) id. Get it from pirsch_list_domains.

pirsch_get_time_distributionGet visitors by time

Read-only

Inspect

Visitors by hour of the day, by minute (only when from and to are the same day), or by weekday and hour (Monday is 0). Shows when traffic peaks. GET /api/v1/statistics/hours, /minutes or /weekdays.

ParametersJSON Schema

Name	Required	Description
`by`	Yes	hour = per hour of day, minute = per minute (needs a one-day range), weekday = weekday and hour.
`os`	No	Operating system. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`to`	Yes	Last day, yyyy-mm-dd, whole day included.
`tz`	No	IANA time zone such as Europe/Berlin. Default: the dashboard's time zone.
`tag`	No	Tag key to filter for.
`city`	No	City name. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`from`	Yes	First day, yyyy-mm-dd (in the dashboard time zone unless tz is set).
`path`	No	Page path, for example /pricing. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`tags`	No	Tag key/value pairs; only results with all pairs match.
`event`	No	Event name. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`browser`	No	Browser. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`channel`	No	Traffic channel such as "Paid Search" or "Organic Search". Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`country`	No	ISO 3166 alpha-2 country code such as jp. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`pattern`	No	Regular expression that filters and groups pages, for example (?i)^/blog/[^/]+$.
`hostname`	No	Hostname (useful for rollup views). Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`language`	No	ISO 639-1 language code such as en. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`platform`	No	Platform.
`referrer`	No	Referrer, usually a URL. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`utm_term`	No	UTM term. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`domain_id`	Yes	Pirsch domain (dashboard) id. Get it from pirsch_list_domains.
`exit_path`	No	Exit page path. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`entry_path`	No	Entry page path. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`event_meta`	No	Event metadata key/value pairs; only events with all pairs match.
`utm_medium`	No	UTM medium. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`utm_source`	No	UTM source. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`utm_content`	No	UTM content. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`screen_class`	No	Screen class XXL, XL, L, M or S. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`utm_campaign`	No	UTM campaign. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`referrer_name`	No	Referrer name, usually the hostname. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).

pirsch_get_totalsGet total visitors

Read-only

Inspect

Totals for a period: visitors, views, sessions, bounces, bounce rate and conversion rate. Not grouped by day, so returning visitors are counted once. GET /api/v1/statistics/total.

ParametersJSON Schema

Name	Required	Description
`os`	No	Operating system. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`to`	Yes	Last day, yyyy-mm-dd, whole day included.
`tz`	No	IANA time zone such as Europe/Berlin. Default: the dashboard's time zone.
`tag`	No	Tag key to filter for.
`city`	No	City name. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`from`	Yes	First day, yyyy-mm-dd (in the dashboard time zone unless tz is set).
`path`	No	Page path, for example /pricing. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`tags`	No	Tag key/value pairs; only results with all pairs match.
`event`	No	Event name. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`browser`	No	Browser. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`channel`	No	Traffic channel such as "Paid Search" or "Organic Search". Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`country`	No	ISO 3166 alpha-2 country code such as jp. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`pattern`	No	Regular expression that filters and groups pages, for example (?i)^/blog/[^/]+$.
`hostname`	No	Hostname (useful for rollup views). Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`language`	No	ISO 639-1 language code such as en. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`platform`	No	Platform.
`referrer`	No	Referrer, usually a URL. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`utm_term`	No	UTM term. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`domain_id`	Yes	Pirsch domain (dashboard) id. Get it from pirsch_list_domains.
`exit_path`	No	Exit page path. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`entry_path`	No	Entry page path. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`event_meta`	No	Event metadata key/value pairs; only events with all pairs match.
`utm_medium`	No	UTM medium. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`utm_source`	No	UTM source. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`utm_content`	No	UTM content. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`screen_class`	No	Screen class XXL, XL, L, M or S. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`utm_campaign`	No	UTM campaign. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`referrer_name`	No	Referrer name, usually the hostname. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).

pirsch_get_visitors_time_seriesGet visitors time series

Read-only

Inspect

Visitors, views, sessions, bounces and bounce rate per day, week, month or year (see scale). Use it for traffic charts and trends. GET /api/v1/statistics/visitor.

ParametersJSON Schema

Name	Required	Description
`os`	No	Operating system. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`to`	Yes	Last day, yyyy-mm-dd, whole day included.
`tz`	No	IANA time zone such as Europe/Berlin. Default: the dashboard's time zone.
`tag`	No	Tag key to filter for.
`city`	No	City name. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`from`	Yes	First day, yyyy-mm-dd (in the dashboard time zone unless tz is set).
`path`	No	Page path, for example /pricing. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`tags`	No	Tag key/value pairs; only results with all pairs match.
`event`	No	Event name. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`scale`	No	Group results by day (default), week, month or year.
`browser`	No	Browser. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`channel`	No	Traffic channel such as "Paid Search" or "Organic Search". Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`country`	No	ISO 3166 alpha-2 country code such as jp. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`pattern`	No	Regular expression that filters and groups pages, for example (?i)^/blog/[^/]+$.
`hostname`	No	Hostname (useful for rollup views). Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`language`	No	ISO 639-1 language code such as en. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`platform`	No	Platform.
`referrer`	No	Referrer, usually a URL. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`utm_term`	No	UTM term. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`domain_id`	Yes	Pirsch domain (dashboard) id. Get it from pirsch_list_domains.
`exit_path`	No	Exit page path. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`entry_path`	No	Entry page path. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`event_meta`	No	Event metadata key/value pairs; only events with all pairs match.
`utm_medium`	No	UTM medium. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`utm_source`	No	UTM source. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`utm_content`	No	UTM content. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`screen_class`	No	Screen class XXL, XL, L, M or S. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`utm_campaign`	No	UTM campaign. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`referrer_name`	No	Referrer name, usually the hostname. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).

pirsch_list_devicesList browsers, operating systems and screens

Read-only

Inspect

Visitors per browser, browser version, operating system or screen class (XXL to S). Filters narrow the data (for example country=de, path=~blog). Results are rows with visitors, views, sessions, bounces and relative shares. GET /api/v1/statistics/browser, /browser/version, /os or /screen.

ParametersJSON Schema

Name	Required	Description
`os`	No	Operating system. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`to`	Yes	Last day, yyyy-mm-dd, whole day included.
`tz`	No	IANA time zone such as Europe/Berlin. Default: the dashboard's time zone.
`tag`	No	Tag key to filter for.
`city`	No	City name. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`from`	Yes	First day, yyyy-mm-dd (in the dashboard time zone unless tz is set).
`path`	No	Page path, for example /pricing. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`sort`	No	Field to sort by, for example visitors, views, sessions or bounce_rate.
`tags`	No	Tag key/value pairs; only results with all pairs match.
`event`	No	Event name. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`limit`	No	Results per page, 1-100 (default 25).
`offset`	No	Results to skip (default 0). Pass the previous reply's next_offset.
`search`	No	Only rows whose main field contains this text.
`browser`	No	Browser. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`channel`	No	Traffic channel such as "Paid Search" or "Organic Search". Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`country`	No	ISO 3166 alpha-2 country code such as jp. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`pattern`	No	Regular expression that filters and groups pages, for example (?i)^/blog/[^/]+$.
`hostname`	No	Hostname (useful for rollup views). Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`language`	No	ISO 639-1 language code such as en. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`platform`	No	Platform.
`referrer`	No	Referrer, usually a URL. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`utm_term`	No	UTM term. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`dimension`	Yes	Which breakdown.
`direction`	No	Sort direction.
`domain_id`	Yes	Pirsch domain (dashboard) id. Get it from pirsch_list_domains.
`exit_path`	No	Exit page path. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`entry_path`	No	Entry page path. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`event_meta`	No	Event metadata key/value pairs; only events with all pairs match.
`utm_medium`	No	UTM medium. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`utm_source`	No	UTM source. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`utm_content`	No	UTM content. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`screen_class`	No	Screen class XXL, XL, L, M or S. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`utm_campaign`	No	UTM campaign. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`referrer_name`	No	Referrer name, usually the hostname. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).

pirsch_list_domainsList domains (dashboards)

Read-only

Inspect

List the Pirsch dashboards (domains) the OAuth client can read: id, hostname, display name, time zone and role. Use the id as domain_id in every other tool. A dashboard-level client sees one domain; an account-level client sees all. GET /api/v1/domain.

ParametersJSON Schema

Name	Required	Description	Default
`search`	No	Only domains whose hostname contains this text.

pirsch_list_event_pagesList pages of an event

Read-only

Inspect

The pages on which an event was triggered, with visitors and views. The event name is required. GET /api/v1/statistics/event/page.

ParametersJSON Schema

Name	Required	Description
`to`	Yes	Last day, yyyy-mm-dd, whole day included.
`tz`	No	IANA time zone such as Europe/Berlin. Default: the dashboard's time zone.
`from`	Yes	First day, yyyy-mm-dd (in the dashboard time zone unless tz is set).
`sort`	No	Field to sort by, for example visitors, views, sessions or bounce_rate.
`event`	Yes	Event name.
`limit`	No	Results per page, 1-100 (default 25).
`offset`	No	Results to skip (default 0). Pass the previous reply's next_offset.
`search`	No	Only rows whose main field contains this text.
`direction`	No	Sort direction.
`domain_id`	Yes	Pirsch domain (dashboard) id. Get it from pirsch_list_domains.

pirsch_list_eventsList events

Read-only

Inspect

Custom events with count, visitors, views, conversion rate, average duration and their metadata keys. Use pirsch_get_event_breakdown for the values of one metadata key. GET /api/v1/statistics/events.

ParametersJSON Schema

Name	Required	Description
`os`	No	Operating system. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`to`	Yes	Last day, yyyy-mm-dd, whole day included.
`tz`	No	IANA time zone such as Europe/Berlin. Default: the dashboard's time zone.
`tag`	No	Tag key to filter for.
`city`	No	City name. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`from`	Yes	First day, yyyy-mm-dd (in the dashboard time zone unless tz is set).
`path`	No	Page path, for example /pricing. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`sort`	No	Field to sort by, for example visitors, views, sessions or bounce_rate.
`tags`	No	Tag key/value pairs; only results with all pairs match.
`event`	No	Event name. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`limit`	No	Results per page, 1-100 (default 25).
`offset`	No	Results to skip (default 0). Pass the previous reply's next_offset.
`search`	No	Only rows whose main field contains this text.
`browser`	No	Browser. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`channel`	No	Traffic channel such as "Paid Search" or "Organic Search". Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`country`	No	ISO 3166 alpha-2 country code such as jp. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`pattern`	No	Regular expression that filters and groups pages, for example (?i)^/blog/[^/]+$.
`hostname`	No	Hostname (useful for rollup views). Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`language`	No	ISO 639-1 language code such as en. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`platform`	No	Platform.
`referrer`	No	Referrer, usually a URL. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`utm_term`	No	UTM term. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`direction`	No	Sort direction.
`domain_id`	Yes	Pirsch domain (dashboard) id. Get it from pirsch_list_domains.
`exit_path`	No	Exit page path. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`entry_path`	No	Entry page path. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`event_meta`	No	Event metadata key/value pairs; only events with all pairs match.
`utm_medium`	No	UTM medium. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`utm_source`	No	UTM source. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`utm_content`	No	UTM content. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`screen_class`	No	Screen class XXL, XL, L, M or S. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`utm_campaign`	No	UTM campaign. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`referrer_name`	No	Referrer name, usually the hostname. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).

pirsch_list_filter_valuesList filter values

Read-only

Inspect

The values that exist for a filter in a period, such as all page paths, referrers, countries, browsers or event names. Use it to find valid values before filtering. GET /api/v1/statistics/options/{dimension}.

ParametersJSON Schema

Name	Required	Description
`to`	Yes	Last day, yyyy-mm-dd, whole day included.
`tz`	No	IANA time zone such as Europe/Berlin. Default: the dashboard's time zone.
`from`	Yes	First day, yyyy-mm-dd (in the dashboard time zone unless tz is set).
`search`	No	Only values that contain this text.
`dimension`	Yes	Which filter to list values for.
`domain_id`	Yes	Pirsch domain (dashboard) id. Get it from pirsch_list_domains.

pirsch_list_funnelsList funnels

Read-only

Inspect

The funnels defined for a dashboard, with their steps and step filters. Use a funnel id in pirsch_get_funnel. GET /api/v1/funnel.

ParametersJSON Schema

Name	Required	Description	Default
`search`	No	Only funnels whose name contains this text.
`domain_id`	Yes	Pirsch domain (dashboard) id. Get it from pirsch_list_domains.

pirsch_list_geographyList countries, regions, cities and languages

Read-only

Inspect

Visitors per country, region, city or language. Filters narrow the data (for example country=de, path=~blog). Results are rows with visitors, views, sessions, bounces and relative shares. GET /api/v1/statistics/country, /region, /city or /language.

ParametersJSON Schema

Name	Required	Description
`os`	No	Operating system. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`to`	Yes	Last day, yyyy-mm-dd, whole day included.
`tz`	No	IANA time zone such as Europe/Berlin. Default: the dashboard's time zone.
`tag`	No	Tag key to filter for.
`city`	No	City name. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`from`	Yes	First day, yyyy-mm-dd (in the dashboard time zone unless tz is set).
`path`	No	Page path, for example /pricing. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`sort`	No	Field to sort by, for example visitors, views, sessions or bounce_rate.
`tags`	No	Tag key/value pairs; only results with all pairs match.
`event`	No	Event name. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`limit`	No	Results per page, 1-100 (default 25).
`offset`	No	Results to skip (default 0). Pass the previous reply's next_offset.
`search`	No	Only rows whose main field contains this text.
`browser`	No	Browser. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`channel`	No	Traffic channel such as "Paid Search" or "Organic Search". Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`country`	No	ISO 3166 alpha-2 country code such as jp. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`pattern`	No	Regular expression that filters and groups pages, for example (?i)^/blog/[^/]+$.
`hostname`	No	Hostname (useful for rollup views). Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`language`	No	ISO 639-1 language code such as en. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`platform`	No	Platform.
`referrer`	No	Referrer, usually a URL. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`utm_term`	No	UTM term. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`dimension`	Yes	Which breakdown.
`direction`	No	Sort direction.
`domain_id`	Yes	Pirsch domain (dashboard) id. Get it from pirsch_list_domains.
`exit_path`	No	Exit page path. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`entry_path`	No	Entry page path. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`event_meta`	No	Event metadata key/value pairs; only events with all pairs match.
`utm_medium`	No	UTM medium. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`utm_source`	No	UTM source. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`utm_content`	No	UTM content. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`screen_class`	No	Screen class XXL, XL, L, M or S. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`utm_campaign`	No	UTM campaign. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`referrer_name`	No	Referrer name, usually the hostname. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).

pirsch_list_goalsList conversion goals

Read-only

Inspect

Conversion goals with their definition (page pattern, event, targets) and the visitors, views and conversion rate for the period. GET /api/v1/statistics/goals.

ParametersJSON Schema

Name	Required	Description
`os`	No	Operating system. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`to`	Yes	Last day, yyyy-mm-dd, whole day included.
`tz`	No	IANA time zone such as Europe/Berlin. Default: the dashboard's time zone.
`tag`	No	Tag key to filter for.
`city`	No	City name. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`from`	Yes	First day, yyyy-mm-dd (in the dashboard time zone unless tz is set).
`path`	No	Page path, for example /pricing. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`sort`	No	Field to sort by, for example visitors, views, sessions or bounce_rate.
`tags`	No	Tag key/value pairs; only results with all pairs match.
`event`	No	Event name. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`limit`	No	Results per page, 1-100 (default 25).
`offset`	No	Results to skip (default 0). Pass the previous reply's next_offset.
`search`	No	Only rows whose main field contains this text.
`browser`	No	Browser. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`channel`	No	Traffic channel such as "Paid Search" or "Organic Search". Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`country`	No	ISO 3166 alpha-2 country code such as jp. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`pattern`	No	Regular expression that filters and groups pages, for example (?i)^/blog/[^/]+$.
`hostname`	No	Hostname (useful for rollup views). Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`language`	No	ISO 639-1 language code such as en. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`platform`	No	Platform.
`referrer`	No	Referrer, usually a URL. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`utm_term`	No	UTM term. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`direction`	No	Sort direction.
`domain_id`	Yes	Pirsch domain (dashboard) id. Get it from pirsch_list_domains.
`exit_path`	No	Exit page path. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`entry_path`	No	Entry page path. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`event_meta`	No	Event metadata key/value pairs; only events with all pairs match.
`utm_medium`	No	UTM medium. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`utm_source`	No	UTM source. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`utm_content`	No	UTM content. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`screen_class`	No	Screen class XXL, XL, L, M or S. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`utm_campaign`	No	UTM campaign. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`referrer_name`	No	Referrer name, usually the hostname. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).

pirsch_list_hostnamesList hostnames

Read-only

Inspect

Traffic per hostname. Mostly useful for rollup views that combine several hostnames. GET /api/v1/statistics/hostname.

ParametersJSON Schema

Name	Required	Description
`os`	No	Operating system. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`to`	Yes	Last day, yyyy-mm-dd, whole day included.
`tz`	No	IANA time zone such as Europe/Berlin. Default: the dashboard's time zone.
`tag`	No	Tag key to filter for.
`city`	No	City name. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`from`	Yes	First day, yyyy-mm-dd (in the dashboard time zone unless tz is set).
`path`	No	Page path, for example /pricing. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`sort`	No	Field to sort by, for example visitors, views, sessions or bounce_rate.
`tags`	No	Tag key/value pairs; only results with all pairs match.
`event`	No	Event name. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`limit`	No	Results per page, 1-100 (default 25).
`offset`	No	Results to skip (default 0). Pass the previous reply's next_offset.
`search`	No	Only rows whose main field contains this text.
`browser`	No	Browser. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`channel`	No	Traffic channel such as "Paid Search" or "Organic Search". Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`country`	No	ISO 3166 alpha-2 country code such as jp. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`pattern`	No	Regular expression that filters and groups pages, for example (?i)^/blog/[^/]+$.
`hostname`	No	Hostname (useful for rollup views). Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`language`	No	ISO 639-1 language code such as en. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`platform`	No	Platform.
`referrer`	No	Referrer, usually a URL. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`utm_term`	No	UTM term. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`direction`	No	Sort direction.
`domain_id`	Yes	Pirsch domain (dashboard) id. Get it from pirsch_list_domains.
`exit_path`	No	Exit page path. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`entry_path`	No	Entry page path. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`event_meta`	No	Event metadata key/value pairs; only events with all pairs match.
`utm_medium`	No	UTM medium. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`utm_source`	No	UTM source. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`utm_content`	No	UTM content. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`screen_class`	No	Screen class XXL, XL, L, M or S. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`utm_campaign`	No	UTM campaign. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`referrer_name`	No	Referrer name, usually the hostname. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).

pirsch_list_pagesList pages

Read-only

Inspect

Top pages with visitors, views, sessions, bounces, bounce rate and average time on page. type=entry lists landing pages, type=exit lists exit pages. Filters narrow the data (for example country=de, path=~blog). Results are rows with visitors, views, sessions, bounces and relative shares. GET /api/v1/statistics/page, /page/entry or /page/exit.

ParametersJSON Schema

Name	Required	Description
`os`	No	Operating system. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`to`	Yes	Last day, yyyy-mm-dd, whole day included.
`tz`	No	IANA time zone such as Europe/Berlin. Default: the dashboard's time zone.
`tag`	No	Tag key to filter for.
`city`	No	City name. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`from`	Yes	First day, yyyy-mm-dd (in the dashboard time zone unless tz is set).
`path`	No	Page path, for example /pricing. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`sort`	No	Field to sort by, for example visitors, views, sessions or bounce_rate.
`tags`	No	Tag key/value pairs; only results with all pairs match.
`type`	No	all (default), entry or exit pages.
`event`	No	Event name. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`limit`	No	Results per page, 1-100 (default 25).
`offset`	No	Results to skip (default 0). Pass the previous reply's next_offset.
`search`	No	Only rows whose main field contains this text.
`browser`	No	Browser. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`channel`	No	Traffic channel such as "Paid Search" or "Organic Search". Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`country`	No	ISO 3166 alpha-2 country code such as jp. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`pattern`	No	Regular expression that filters and groups pages, for example (?i)^/blog/[^/]+$.
`hostname`	No	Hostname (useful for rollup views). Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`language`	No	ISO 639-1 language code such as en. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`platform`	No	Platform.
`referrer`	No	Referrer, usually a URL. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`utm_term`	No	UTM term. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`direction`	No	Sort direction.
`domain_id`	Yes	Pirsch domain (dashboard) id. Get it from pirsch_list_domains.
`exit_path`	No	Exit page path. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`entry_path`	No	Entry page path. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`event_meta`	No	Event metadata key/value pairs; only events with all pairs match.
`utm_medium`	No	UTM medium. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`utm_source`	No	UTM source. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`utm_content`	No	UTM content. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`screen_class`	No	Screen class XXL, XL, L, M or S. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`utm_campaign`	No	UTM campaign. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`include_title`	No	Group by title and path instead of path only.
`referrer_name`	No	Referrer name, usually the hostname. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).

pirsch_list_referrersList referrers

Read-only

Inspect

Where visitors come from: referrers (by=referrer) or traffic channels such as Organic Search and Paid Search (by=channel). Filters narrow the data (for example country=de, path=~blog). Results are rows with visitors, views, sessions, bounces and relative shares. GET /api/v1/statistics/referrer or /channel.

ParametersJSON Schema

Name	Required	Description
`by`	No	referrer (default) or channel.
`os`	No	Operating system. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`to`	Yes	Last day, yyyy-mm-dd, whole day included.
`tz`	No	IANA time zone such as Europe/Berlin. Default: the dashboard's time zone.
`tag`	No	Tag key to filter for.
`city`	No	City name. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`from`	Yes	First day, yyyy-mm-dd (in the dashboard time zone unless tz is set).
`path`	No	Page path, for example /pricing. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`sort`	No	Field to sort by, for example visitors, views, sessions or bounce_rate.
`tags`	No	Tag key/value pairs; only results with all pairs match.
`event`	No	Event name. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`limit`	No	Results per page, 1-100 (default 25).
`offset`	No	Results to skip (default 0). Pass the previous reply's next_offset.
`search`	No	Only rows whose main field contains this text.
`browser`	No	Browser. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`channel`	No	Traffic channel such as "Paid Search" or "Organic Search". Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`country`	No	ISO 3166 alpha-2 country code such as jp. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`pattern`	No	Regular expression that filters and groups pages, for example (?i)^/blog/[^/]+$.
`hostname`	No	Hostname (useful for rollup views). Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`language`	No	ISO 639-1 language code such as en. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`platform`	No	Platform.
`referrer`	No	Referrer, usually a URL. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`utm_term`	No	UTM term. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`direction`	No	Sort direction.
`domain_id`	Yes	Pirsch domain (dashboard) id. Get it from pirsch_list_domains.
`exit_path`	No	Exit page path. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`entry_path`	No	Entry page path. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`event_meta`	No	Event metadata key/value pairs; only events with all pairs match.
`utm_medium`	No	UTM medium. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`utm_source`	No	UTM source. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`utm_content`	No	UTM content. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`screen_class`	No	Screen class XXL, XL, L, M or S. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`utm_campaign`	No	UTM campaign. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`referrer_name`	No	Referrer name, usually the hostname. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).

pirsch_list_sessionsList sessions

Read-only

Inspect

Individual visitor sessions: start, duration, entry and exit page, page views, bounce, country, city, referrer, browser, OS and UTM data. visitor_id is a string (a 64-bit number). Use pirsch_get_session for one session's page views and events. GET /api/v1/statistics/session/list.

ParametersJSON Schema

Name	Required	Description
`os`	No	Operating system. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`to`	Yes	Last day, yyyy-mm-dd, whole day included.
`tz`	No	IANA time zone such as Europe/Berlin. Default: the dashboard's time zone.
`tag`	No	Tag key to filter for.
`city`	No	City name. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`from`	Yes	First day, yyyy-mm-dd (in the dashboard time zone unless tz is set).
`path`	No	Page path, for example /pricing. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`sort`	No	Field to sort by, for example visitors, views, sessions or bounce_rate.
`tags`	No	Tag key/value pairs; only results with all pairs match.
`event`	No	Event name. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`limit`	No	Results per page, 1-100 (default 25).
`offset`	No	Results to skip (default 0). Pass the previous reply's next_offset.
`search`	No	Only rows whose main field contains this text.
`browser`	No	Browser. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`channel`	No	Traffic channel such as "Paid Search" or "Organic Search". Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`country`	No	ISO 3166 alpha-2 country code such as jp. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`pattern`	No	Regular expression that filters and groups pages, for example (?i)^/blog/[^/]+$.
`hostname`	No	Hostname (useful for rollup views). Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`language`	No	ISO 639-1 language code such as en. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`platform`	No	Platform.
`referrer`	No	Referrer, usually a URL. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`utm_term`	No	UTM term. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`direction`	No	Sort direction.
`domain_id`	Yes	Pirsch domain (dashboard) id. Get it from pirsch_list_domains.
`exit_path`	No	Exit page path. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`entry_path`	No	Entry page path. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`event_meta`	No	Event metadata key/value pairs; only events with all pairs match.
`utm_medium`	No	UTM medium. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`utm_source`	No	UTM source. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`utm_content`	No	UTM content. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`screen_class`	No	Screen class XXL, XL, L, M or S. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`utm_campaign`	No	UTM campaign. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`referrer_name`	No	Referrer name, usually the hostname. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).

pirsch_list_tagsList tags

Read-only

Inspect

Tag keys with views and share. Use pirsch_get_tag_breakdown to see the values of one key. GET /api/v1/statistics/tags.

ParametersJSON Schema

Name	Required	Description
`os`	No	Operating system. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`to`	Yes	Last day, yyyy-mm-dd, whole day included.
`tz`	No	IANA time zone such as Europe/Berlin. Default: the dashboard's time zone.
`tag`	No	Tag key to filter for.
`city`	No	City name. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`from`	Yes	First day, yyyy-mm-dd (in the dashboard time zone unless tz is set).
`path`	No	Page path, for example /pricing. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`sort`	No	Field to sort by, for example visitors, views, sessions or bounce_rate.
`tags`	No	Tag key/value pairs; only results with all pairs match.
`event`	No	Event name. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`limit`	No	Results per page, 1-100 (default 25).
`offset`	No	Results to skip (default 0). Pass the previous reply's next_offset.
`search`	No	Only rows whose main field contains this text.
`browser`	No	Browser. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`channel`	No	Traffic channel such as "Paid Search" or "Organic Search". Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`country`	No	ISO 3166 alpha-2 country code such as jp. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`pattern`	No	Regular expression that filters and groups pages, for example (?i)^/blog/[^/]+$.
`hostname`	No	Hostname (useful for rollup views). Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`language`	No	ISO 639-1 language code such as en. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`platform`	No	Platform.
`referrer`	No	Referrer, usually a URL. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`utm_term`	No	UTM term. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`direction`	No	Sort direction.
`domain_id`	Yes	Pirsch domain (dashboard) id. Get it from pirsch_list_domains.
`exit_path`	No	Exit page path. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`entry_path`	No	Entry page path. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`event_meta`	No	Event metadata key/value pairs; only events with all pairs match.
`utm_medium`	No	UTM medium. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`utm_source`	No	UTM source. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`utm_content`	No	UTM content. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`screen_class`	No	Screen class XXL, XL, L, M or S. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`utm_campaign`	No	UTM campaign. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`referrer_name`	No	Referrer name, usually the hostname. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).

pirsch_list_utmList UTM parameters

Read-only

Inspect

Visitors per UTM source, medium, campaign, content or term. Filters narrow the data (for example country=de, path=~blog). Results are rows with visitors, views, sessions, bounces and relative shares. GET /api/v1/statistics/utm/{dimension}.

ParametersJSON Schema

Name	Required	Description
`os`	No	Operating system. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`to`	Yes	Last day, yyyy-mm-dd, whole day included.
`tz`	No	IANA time zone such as Europe/Berlin. Default: the dashboard's time zone.
`tag`	No	Tag key to filter for.
`city`	No	City name. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`from`	Yes	First day, yyyy-mm-dd (in the dashboard time zone unless tz is set).
`path`	No	Page path, for example /pricing. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`sort`	No	Field to sort by, for example visitors, views, sessions or bounce_rate.
`tags`	No	Tag key/value pairs; only results with all pairs match.
`event`	No	Event name. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`limit`	No	Results per page, 1-100 (default 25).
`offset`	No	Results to skip (default 0). Pass the previous reply's next_offset.
`search`	No	Only rows whose main field contains this text.
`browser`	No	Browser. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`channel`	No	Traffic channel such as "Paid Search" or "Organic Search". Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`country`	No	ISO 3166 alpha-2 country code such as jp. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`pattern`	No	Regular expression that filters and groups pages, for example (?i)^/blog/[^/]+$.
`hostname`	No	Hostname (useful for rollup views). Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`language`	No	ISO 639-1 language code such as en. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`platform`	No	Platform.
`referrer`	No	Referrer, usually a URL. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`utm_term`	No	UTM term. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`dimension`	Yes	Which UTM parameter to break down.
`direction`	No	Sort direction.
`domain_id`	Yes	Pirsch domain (dashboard) id. Get it from pirsch_list_domains.
`exit_path`	No	Exit page path. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`entry_path`	No	Entry page path. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`event_meta`	No	Event metadata key/value pairs; only events with all pairs match.
`utm_medium`	No	UTM medium. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`utm_source`	No	UTM source. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`utm_content`	No	UTM content. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`screen_class`	No	Screen class XXL, XL, L, M or S. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`utm_campaign`	No	UTM campaign. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
`referrer_name`	No	Referrer name, usually the hostname. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).

Tool Schema Changelog

Recent tool additions, removals, and schema changes observed during successful MCP inspections.

27 tool updatesOct 10, 2026
- First observedpirsch_get_active_visitors
- First observedpirsch_get_domain
- First observedpirsch_get_duration
- First observedpirsch_get_event_breakdown
- First observedpirsch_get_funnel
- First observedpirsch_get_growth
- First observedpirsch_get_overview
- First observedpirsch_get_platforms
- First observedpirsch_get_session
- First observedpirsch_get_tag_breakdown
- First observedpirsch_get_time_distribution
- First observedpirsch_get_totals
- First observedpirsch_get_visitors_time_series
- First observedpirsch_list_devices
- First observedpirsch_list_domains
- First observedpirsch_list_event_pages
- First observedpirsch_list_events
- First observedpirsch_list_filter_values
- First observedpirsch_list_funnels
- First observedpirsch_list_geography
- First observedpirsch_list_goals
- First observedpirsch_list_hostnames
- First observedpirsch_list_pages
- First observedpirsch_list_referrers
- First observedpirsch_list_sessions
- First observedpirsch_list_tags
- First observedpirsch_list_utm

Related MCP Connectors

Simple Analytics MCP by usefulapi
io.usefulapi
Read Simple Analytics stats: pageviews, visitors, pages, referrers, events and data exports.
61
Measure.events Analytics A
io.github.meetclawdius
Privacy-first web analytics. Query pageviews, referrers, trends, and AI insights.
Monitoring Search Data Platforms
622
Chad Analytics
com.chadanalytics
Read-only website analytics, AI referrals, crawlers, goals, revenue, and funnels.
Monitoring Marketing
2
Plausible MCP by usefulapi A
io.usefulapi
Query site stats, realtime visitors, breakdowns and goals from Plausible Analytics.
Monitoring Marketing
81

Related MCP Servers

Matomo MCP
Marketing Monitoring
pipeworx-io
A
license
Not graded
quality
B
maintenance
Read website acquisition, content, conversion, and engagement analytics from Matomo's Reporting API.
Updated 14 days ago (2026-09-26 19:39 UTC)
248 npm
MIT
@zgeoff/umami-mcp
Monitoring Observability
zgeoff
A
license
Not graded
quality
D
maintenance
Exposes Umami analytics (Cloud or self-hosted) as read-only tools for querying website stats, pageviews, metrics, and active visitors.
Updated 3 months ago (2026-07-17 23:09 UTC)
74 npm
MIT
@icjia/plausible-mcp
Monitoring Observability
ICJIA
A
license
A
quality
D
maintenance
Enables querying a self-hosted Plausible Analytics instance to retrieve compressed analytics data such as overview stats, top pages, traffic sources, and trends, with computed deltas and human-readable filters.
Updated 6 months ago (2026-04-09 16:07 UTC)
6
21 npm
MIT
Cookie Free Analytics MCP
Monitoring Observability
PrestonsCreekCapital
A
license
Not graded
quality
C
maintenance
Enables read-only access to cookieless web analytics aggregates such as sites, visitors, pages, sources, live activity, funnels, and uptime monitoring through OAuth 2.1-secured Streamable HTTP tools.
Updated 18 days ago (2026-09-22 19:54 UTC)
MIT

Try in Browser

One endpoint for every MCP toolRayrun runs every MCP server behind one URL and holds the credentials. Each call is decided per client, tool, and argument, then recorded.ray.runAd

Glama MCP Gateway

Add one secure layer between your agents and this server.

Server Details

TDQS

Available Tools

Tool Schema Changelog

Related MCP Connectors

Related MCP Servers

Matomo MCP

@zgeoff/umami-mcp

@icjia/plausible-mcp

Cookie Free Analytics MCP

Glama MCP Gateway

Resources