Servers Playground How we check Add a server Log in

Pirsch Analytics MCP by usefulapi

Working · 788 ms

io.usefulapi/pirschv1.4.0 Domain verified

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

Marketing & SEO

Source Website Registry entry

Maintain this server? Claim it

Try it

Call this server's tools from your browser. Nothing to install.

https://pirsch.usefulapi.io/mcp

Requests go through mcptry because browsers can't call most MCP servers directly. Header values are sent to the server for that request only and are never stored or logged.

Tool list from our last check. Connect live to refresh it.

pirsch_get_active_visitors Read-only

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.

domain_idstring, required

Pirsch domain (dashboard) id. Get it from pirsch_list_domains.

startinteger

Look back this many seconds, 1-3600 (default 600 = 10 minutes).

Pirsch Analytics MCP by usefulapi MCP server | mcptry

Tools (27)

pirsch_get_active_visitors

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.

read-only

Argument	Type	Description
start	integer	Look back this many seconds, 1-3600 (default 600 = 10 minutes).
domain_id*	string	Pirsch domain (dashboard) id. Get it from pirsch_list_domains.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "domain_id"
  ],
  "properties": {
    "start": {
      "type": "integer",
      "maximum": 3600,
      "minimum": 1,
      "description": "Look back this many seconds, 1-3600 (default 600 = 10 minutes)."
    },
    "domain_id": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_-]+$",
      "maxLength": 64,
      "minLength": 1,
      "description": "Pirsch domain (dashboard) id. Get it from pirsch_list_domains."
    }
  }
}

pirsch_get_domain

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

read-only

Argument	Type	Description
domain_id*	string	Pirsch domain (dashboard) id. Get it from pirsch_list_domains.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "domain_id"
  ],
  "properties": {
    "domain_id": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_-]+$",
      "maxLength": 64,
      "minLength": 1,
      "description": "Pirsch domain (dashboard) id. Get it from pirsch_list_domains."
    }
  }
}

pirsch_get_duration

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

read-only

Argument	Type	Description
os	string	Operating system. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
to*	string	Last day, yyyy-mm-dd, whole day included.
tz	string	IANA time zone such as Europe/Berlin. Default: the dashboard's time zone.
tag	string	Tag key to filter for.
city	string	City name. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
from*	string	First day, yyyy-mm-dd (in the dashboard time zone unless tz is set).
kind*	string	session = average session duration, page = average time on page.
path	string	Page path, for example /pricing. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).

pirsch_get_event_breakdown

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.

read-only

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

pirsch_get_funnel

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.

read-only

Argument	Type	Description
os	string	Operating system. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
to*	string	Last day, yyyy-mm-dd, whole day included.
tz	string	IANA time zone such as Europe/Berlin. Default: the dashboard's time zone.
tag	string	Tag key to filter for.
city	string	City name. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
from*	string	First day, yyyy-mm-dd (in the dashboard time zone unless tz is set).
path	string	Page path, for example /pricing. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
tags	object	Tag key/value pairs; only results with all pairs match.

pirsch_get_growth

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.

read-only

Argument	Type	Description
os	string	Operating system. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
to*	string	Last day, yyyy-mm-dd, whole day included.
tz	string	IANA time zone such as Europe/Berlin. Default: the dashboard's time zone.
tag	string	Tag key to filter for.
city	string	City name. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
from*	string	First day, yyyy-mm-dd (in the dashboard time zone unless tz is set).
path	string	Page path, for example /pricing. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
tags	object	Tag key/value pairs; only results with all pairs match.

pirsch_get_overview

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.

read-only

Argument	Type	Description
domain_id*	string	Pirsch domain (dashboard) id. Get it from pirsch_list_domains.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "domain_id"
  ],
  "properties": {
    "domain_id": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_-]+$",
      "maxLength": 64,
      "minLength": 1,
      "description": "Pirsch domain (dashboard) id. Get it from pirsch_list_domains."
    }
  }
}

pirsch_get_platforms

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

read-only

Argument	Type	Description
os	string	Operating system. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
to*	string	Last day, yyyy-mm-dd, whole day included.
tz	string	IANA time zone such as Europe/Berlin. Default: the dashboard's time zone.
tag	string	Tag key to filter for.
city	string	City name. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
from*	string	First day, yyyy-mm-dd (in the dashboard time zone unless tz is set).
path	string	Page path, for example /pricing. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
tags	object	Tag key/value pairs; only results with all pairs match.

pirsch_get_session

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

read-only

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

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "domain_id",
    "from",
    "to",
    "visitor_id",
    "session_id"
  ],
  "properties": {
    "to": {
      "type": "string",
      "pattern": "^(\\d{4})-(\\d{2})-(\\d{2})$",
      "description": "Last day, yyyy-mm-dd, whole day included."
    },
    "tz": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_+\\-/]+$",
      "maxLength": 64,
      "minLength": 1,
      "description": "IANA time zone such as Europe/Berlin. Default: the dashboard's time zone."
    },
    "from": {
      "type": "string",
      "pattern": "^(\\d{4})-(\\d{2})-(\\d{2})$",
      "description": "First day, yyyy-mm-dd (in the dashboard time zone unless tz is set)."
    },
    "domain_id": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_-]+$",
      "maxLength": 64,
      "minLength": 1,
      "description": "Pirsch domain (dashboard) id. Get it from pirsch_list_domains."
    },
    "session_id": {
      "type": "string",
      "pattern": "^\\d{1,20}$",
      "description": "session_id from pirsch_list_sessions."
    },
    "visitor_id": {
      "type": "string",
      "pattern": "^\\d{1,20}$",
      "description": "visitor_id from pirsch_list_sessions."
    }
  }
}

pirsch_get_tag_breakdown

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

read-only

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

pirsch_get_time_distribution

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.

read-only

Argument	Type	Description
by*	string	hour = per hour of day, minute = per minute (needs a one-day range), weekday = weekday and hour.
os	string	Operating system. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
to*	string	Last day, yyyy-mm-dd, whole day included.
tz	string	IANA time zone such as Europe/Berlin. Default: the dashboard's time zone.
tag	string	Tag key to filter for.
city	string	City name. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
from*	string	First day, yyyy-mm-dd (in the dashboard time zone unless tz is set).
path	string

pirsch_get_totals

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.

read-only

Argument	Type	Description
os	string	Operating system. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
to*	string	Last day, yyyy-mm-dd, whole day included.
tz	string	IANA time zone such as Europe/Berlin. Default: the dashboard's time zone.
tag	string	Tag key to filter for.
city	string	City name. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
from*	string	First day, yyyy-mm-dd (in the dashboard time zone unless tz is set).
path	string	Page path, for example /pricing. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
tags	object	Tag key/value pairs; only results with all pairs match.

pirsch_get_visitors_time_series

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.

read-only

Argument	Type	Description
os	string	Operating system. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
to*	string	Last day, yyyy-mm-dd, whole day included.
tz	string	IANA time zone such as Europe/Berlin. Default: the dashboard's time zone.
tag	string	Tag key to filter for.
city	string	City name. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
from*	string	First day, yyyy-mm-dd (in the dashboard time zone unless tz is set).
path	string	Page path, for example /pricing. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
tags	object	Tag key/value pairs; only results with all pairs match.

pirsch_list_devices

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.

read-only

Argument	Type	Description
os	string	Operating system. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
to*	string	Last day, yyyy-mm-dd, whole day included.
tz	string	IANA time zone such as Europe/Berlin. Default: the dashboard's time zone.
tag	string	Tag key to filter for.
city	string	City name. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
from*	string	First day, yyyy-mm-dd (in the dashboard time zone unless tz is set).
path	string	Page path, for example /pricing. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
sort

pirsch_list_domains

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.

read-only

Argument	Type	Description
search	string	Only domains whose hostname contains this text.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "search": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1,
      "description": "Only domains whose hostname contains this text."
    }
  }
}

pirsch_list_event_pages

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

read-only

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

pirsch_list_events

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.

read-only

Argument	Type	Description
os	string	Operating system. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
to*	string	Last day, yyyy-mm-dd, whole day included.
tz	string	IANA time zone such as Europe/Berlin. Default: the dashboard's time zone.
tag	string	Tag key to filter for.
city	string	City name. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
from*	string	First day, yyyy-mm-dd (in the dashboard time zone unless tz is set).
path	string	Page path, for example /pricing. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
sort	string	Field to sort by, for example visitors, views, sessions or bounce_rate.

pirsch_list_filter_values

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

read-only

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

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "domain_id",
    "from",
    "to",
    "dimension"
  ],
  "properties": {
    "to": {
      "type": "string",
      "pattern": "^(\\d{4})-(\\d{2})-(\\d{2})$",
      "description": "Last day, yyyy-mm-dd, whole day included."
    },
    "tz": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_+\\-/]+$",
      "maxLength": 64,
      "minLength": 1,
      "description": "IANA time zone such as Europe/Berlin. Default: the dashboard's time zone."
    },
    "from": {
      "type": "string",
      "pattern": "^(\\d{4})-(\\d{2})-(\\d{2})$",
      "description": "First day, yyyy-mm-dd (in the dashboard time zone unless tz is set)."
    },
    "search": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1,
      "description": "Only values that contain this text."
    },
    "dimension": {
      "enum": [
        "hostname",
        "page",
        "referrer",
        "channel",
        "event",
        "country",
        "region",
        "city",
        "language",
        "browser",
        "os",
        "utm/source",
        "utm/medium",
        "utm/campaign",
        "utm/content",
        "utm/term",
        "tag",
        "metadata/keys"
      ],
      "type": "string",
      "description": "Which filter to list values for."
    },
    "domain_id": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_-]+$",
      "maxLength": 64,
      "minLength": 1,
      "description": "Pirsch domain (dashboard) id. Get it from pirsch_list_domains."
    }
  }
}

pirsch_list_funnels

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

read-only

Argument	Type	Description
search	string	Only funnels whose name contains this text.
domain_id*	string	Pirsch domain (dashboard) id. Get it from pirsch_list_domains.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "domain_id"
  ],
  "properties": {
    "search": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1,
      "description": "Only funnels whose name contains this text."
    },
    "domain_id": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_-]+$",
      "maxLength": 64,
      "minLength": 1,
      "description": "Pirsch domain (dashboard) id. Get it from pirsch_list_domains."
    }
  }
}

pirsch_list_geography

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.

read-only

Argument	Type	Description
os	string	Operating system. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
to*	string	Last day, yyyy-mm-dd, whole day included.
tz	string	IANA time zone such as Europe/Berlin. Default: the dashboard's time zone.
tag	string	Tag key to filter for.
city	string	City name. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
from*	string	First day, yyyy-mm-dd (in the dashboard time zone unless tz is set).
path	string	Page path, for example /pricing. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
sort	string

pirsch_list_goals

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

read-only

Argument	Type	Description
os	string	Operating system. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
to*	string	Last day, yyyy-mm-dd, whole day included.
tz	string	IANA time zone such as Europe/Berlin. Default: the dashboard's time zone.
tag	string	Tag key to filter for.
city	string	City name. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
from*	string	First day, yyyy-mm-dd (in the dashboard time zone unless tz is set).
path	string	Page path, for example /pricing. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
sort	string	Field to sort by, for example visitors, views, sessions or bounce_rate.

pirsch_list_hostnames

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

read-only

Argument	Type	Description
os	string	Operating system. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
to*	string	Last day, yyyy-mm-dd, whole day included.
tz	string	IANA time zone such as Europe/Berlin. Default: the dashboard's time zone.
tag	string	Tag key to filter for.
city	string	City name. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
from*	string	First day, yyyy-mm-dd (in the dashboard time zone unless tz is set).
path	string	Page path, for example /pricing. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
sort	string	Field to sort by, for example visitors, views, sessions or bounce_rate.

pirsch_list_pages

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.

read-only

Argument	Type	Description
os	string	Operating system. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
to*	string	Last day, yyyy-mm-dd, whole day included.
tz	string	IANA time zone such as Europe/Berlin. Default: the dashboard's time zone.
tag	string	Tag key to filter for.
city	string	City name. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
from*	string	First day, yyyy-mm-dd (in the dashboard time zone unless tz is set).
path	string	Page path, for example /pricing. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).

pirsch_list_referrers

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.

read-only

Argument	Type	Description
by	string	referrer (default) or channel.
os	string	Operating system. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
to*	string	Last day, yyyy-mm-dd, whole day included.
tz	string	IANA time zone such as Europe/Berlin. Default: the dashboard's time zone.
tag	string	Tag key to filter for.
city	string	City name. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
from*	string	First day, yyyy-mm-dd (in the dashboard time zone unless tz is set).
path	string

pirsch_list_sessions

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.

read-only

Argument	Type	Description
os	string	Operating system. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
to*	string	Last day, yyyy-mm-dd, whole day included.
tz	string	IANA time zone such as Europe/Berlin. Default: the dashboard's time zone.
tag	string	Tag key to filter for.
city	string	City name. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
from*	string	First day, yyyy-mm-dd (in the dashboard time zone unless tz is set).
path	string	Page path, for example /pricing. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
sort

pirsch_list_tags

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

read-only

Argument	Type	Description
os	string	Operating system. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
to*	string	Last day, yyyy-mm-dd, whole day included.
tz	string	IANA time zone such as Europe/Berlin. Default: the dashboard's time zone.
tag	string	Tag key to filter for.
city	string	City name. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
from*	string	First day, yyyy-mm-dd (in the dashboard time zone unless tz is set).
path	string	Page path, for example /pricing. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
sort	string	Field to sort by, for example visitors, views, sessions or bounce_rate.

pirsch_list_utm

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

read-only

Argument	Type	Description
os	string	Operating system. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
to*	string	Last day, yyyy-mm-dd, whole day included.
tz	string	IANA time zone such as Europe/Berlin. Default: the dashboard's time zone.
tag	string	Tag key to filter for.
city	string	City name. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
from*	string	First day, yyyy-mm-dd (in the dashboard time zone unless tz is set).
path	string	Page path, for example /pricing. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).
sort	string

Input schema (JSON)

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

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "domain_id",
    "from",
    "to",
    "event",
    "event_meta_key"
  ],
  "properties": {
    "to": {
      "type": "string",
      "pattern": "^(\\d{4})-(\\d{2})-(\\d{2})$",
      "description": "Last day, yyyy-mm-dd, whole day included."
    },
    "tz": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_+\\-/]+$",
      "maxLength": 64,
      "minLength": 1,
      "description": "IANA time zone such as Europe/Berlin. Default: the dashboard's time zone."
    },
    "from": {
      "type": "string",
      "pattern": "^(\\d{4})-(\\d{2})-(\\d{2})$",
      "description": "First day, yyyy-mm-dd (in the dashboard time zone unless tz is set)."
    },
    "sort": {
      "type": "string",
      "pattern": "^[a-z_]{1,40}$",
      "description": "Field to sort by, for example visitors, views, sessions or bounce_rate."
    },
    "event": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1,
      "description": "Event name."
    },
    "limit": {
      "type": "integer",
      "maximum": 100,
      "minimum": 1,
      "description": "Results per page, 1-100 (default 25)."
    },
    "offset": {
      "type": "integer",
      "maximum": 1000000,
      "minimum": 0,
      "description": "Results to skip (default 0). Pass the previous reply's next_offset."
    },
    "search": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1,
      "description": "Only rows whose main field contains this text."
    },
    "direction": {
      "enum": [
        "asc",
        "desc"
      ],
      "type": "string",
      "description": "Sort direction."
    },
    "domain_id": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_-]+$",
      "maxLength": 64,
      "minLength": 1,
      "description": "Pirsch domain (dashboard) id. Get it from pirsch_list_domains."
    },
    "event_meta_key": {
      "type": "string",
      "maxLength": 200,
      "minLength": 1,
      "description": "Metadata key to break down."
    }
  }
}

Input schema (JSON)

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

Input schema (JSON)

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

Input schema (JSON)

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

Input schema (JSON)

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

Input schema (JSON)

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

Input schema (JSON)

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

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "domain_id",
    "from",
    "to",
    "dimension"
  ],
  "properties": {
    "os": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1,
      "description": "Operating system. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain)."
    },
    "to": {
      "type": "string",
      "pattern": "^(\\d{4})-(\\d{2})-(\\d{2})$",
      "description": "Last day, yyyy-mm-dd, whole day included."
    },
    "tz": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_+\\-/]+$",
      "maxLength": 64,
      "minLength": 1,
      "description": "IANA time zone such as Europe/Berlin. Default: the dashboard's time zone."
    },
    "tag": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1,
      "description": "Tag key to filter for."
    },
    "city": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1,
      "description": "City name. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain)."
    },
    "from": {
      "type": "string",
      "pattern": "^(\\d{4})-(\\d{2})-(\\d{2})$",
      "description": "First day, yyyy-mm-dd (in the dashboard time zone unless tz is set)."
    },
    "path": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1,
      "description": "Page path, for example /pricing. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain)."
    },
    "sort": {
      "type": "string",
      "pattern": "^[a-z_]{1,40}$",
      "description": "Field to sort by, for example visitors, views, sessions or bounce_rate."
    },
    "tags": {
      "type": "object",
      "description": "Tag key/value pairs; only results with all pairs match.",
      "propertyNames": {
        "type": "string"
      },
      "additionalProperties": {
        "type": "string",
        "maxLength": 500
      }
    },
    "event": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1,
      "description": "Event name. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain)."
    },
    "limit": {
      "type": "integer",
      "maximum": 100,
      "minimum": 1,
      "description": "Results per page, 1-100 (default 25)."
    },
    "offset": {
      "type": "integer",
      "maximum": 1000000,
      "minimum": 0,
      "description": "Results to skip (default 0). Pass the previous reply's next_offset."
    },
    "search": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1,
      "description": "Only rows whose main field contains this text."
    },
    "browser": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1,
      "description": "Browser. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain)."
    },
    "channel": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1,
      "description": "Traffic channel such as \"Paid Search\" or \"Organic Search\". Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain)."
    },
    "country": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1,
      "description": "ISO 3166 alpha-2 country code such as jp. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain)."
    },
    "pattern": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1,
      "description": "Regular expression that filters and groups pages, for example (?i)^/blog/[^/]+$."
    },
    "hostname": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1,
      "description": "Hostname (useful for rollup views). Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain)."
    },
    "language": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1,
      "description": "ISO 639-1 language code such as en. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain)."
    },
    "platform": {
      "enum": [
        "desktop",
        "mobile",
        "unknown"
      ],
      "type": "string",
      "description": "Platform."
    },
    "referrer": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1,
      "description": "Referrer, usually a URL. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain)."
    },
    "utm_term": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1,
      "description": "UTM term. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain)."
    },
    "dimension": {
      "enum": [
        "browser",
        "browser_version",
        "os",
        "screen"
      ],
      "type": "string",
      "description": "Which breakdown."
    },
    "direction": {
      "enum": [
        "asc",
        "desc"
      ],
      "type": "string",
      "description": "Sort direction."
    },
    "domain_id": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_-]+$",
      "maxLength": 64,
      "minLength": 1,
      "description": "Pirsch domain (dashboard) id. Get it from pirsch_list_domains."
    },
    "exit_path": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1,
      "description": "Exit page path. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain)."
    },
    "entry_path": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1,
      "description": "Entry page path. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain)."
    },
    "event_meta": {
      "type": "object",
      "description": "Event metadata key/value pairs; only events with all pairs match.",
      "propertyNames": {
        "type": "string"
      },
      "additionalProperties": {
        "type": "string",
        "maxLength": 500
      }
    },
    "utm_medium": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1,
      "description": "UTM medium. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain)."
    },
    "utm_source": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1,
      "description": "UTM source. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain)."
    },
    "utm_content": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1,
      "description": "UTM content. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain)."
    },
    "screen_class": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1,
      "description": "Screen class XXL, XL, L, M or S. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain)."
    },
    "utm_campaign": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1,
      "description": "UTM campaign. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain)."
    },
    "referrer_name": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1,
      "description": "Referrer name, usually the hostname. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain)."
    }
  }
}

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "domain_id",
    "from",
    "to"
  ],
  "properties": {
    "os": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1,
      "description": "Operating system. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain)."
    },
    "to": {
      "type": "string",
      "pattern": "^(\\d{4})-(\\d{2})-(\\d{2})$",
      "description": "Last day, yyyy-mm-dd, whole day included."
    },
    "tz": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_+\\-/]+$",
      "maxLength": 64,
      "minLength": 1,
      "description": "IANA time zone such as Europe/Berlin. Default: the dashboard's time zone."
    },
    "tag": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1,
      "description": "Tag key to filter for."
    },
    "city": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1,
      "description": "City name. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain)."
    },
    "from": {
      "type": "string",
      "pattern": "^(\\d{4})-(\\d{2})-(\\d{2})$",
      "description": "First day, yyyy-mm-dd (in the dashboard time zone unless tz is set)."
    },
    "path": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1,
      "description": "Page path, for example /pricing. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain)."
    },
    "sort": {
      "type": "string",
      "pattern": "^[a-z_]{1,40}$",
      "description": "Field to sort by, for example visitors, views, sessions or bounce_rate."
    },
    "tags": {
      "type": "object",
      "description": "Tag key/value pairs; only results with all pairs match.",
      "propertyNames": {
        "type": "string"
      },
      "additionalProperties": {
        "type": "string",
        "maxLength": 500
      }
    },
    "event": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1,
      "description": "Event name. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain)."
    },
    "limit": {
      "type": "integer",
      "maximum": 100,
      "minimum": 1,
      "description": "Results per page, 1-100 (default 25)."
    },
    "offset": {
      "type": "integer",
      "maximum": 1000000,
      "minimum": 0,
      "description": "Results to skip (default 0). Pass the previous reply's next_offset."
    },
    "search": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1,
      "description": "Only rows whose main field contains this text."
    },
    "browser": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1,
      "description": "Browser. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain)."
    },
    "channel": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1,
      "description": "Traffic channel such as \"Paid Search\" or \"Organic Search\". Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain)."
    },
    "country": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1,
      "description": "ISO 3166 alpha-2 country code such as jp. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain)."
    },
    "pattern": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1,
      "description": "Regular expression that filters and groups pages, for example (?i)^/blog/[^/]+$."
    },
    "hostname": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1,
      "description": "Hostname (useful for rollup views). Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain)."
    },
    "language": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1,
      "description": "ISO 639-1 language code such as en. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain)."
    },
    "platform": {
      "enum": [
        "desktop",
        "mobile",
        "unknown"
      ],
      "type": "string",
      "description": "Platform."
    },
    "referrer": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1,
      "description": "Referrer, usually a URL. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain)."
    },
    "utm_term": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1,
      "description": "UTM term. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain)."
    },
    "direction": {
      "enum": [
        "asc",
        "desc"
      ],
      "type": "string",
      "description": "Sort direction."
    },
    "domain_id": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_-]+$",
      "maxLength": 64,
      "minLength": 1,
      "description": "Pirsch domain (dashboard) id. Get it from pirsch_list_domains."
    },
    "exit_path": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1,
      "description": "Exit page path. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain)."
    },
    "entry_path": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1,
      "description": "Entry page path. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain)."
    },
    "event_meta": {
      "type": "object",
      "description": "Event metadata key/value pairs; only events with all pairs match.",
      "propertyNames": {
        "type": "string"
      },
      "additionalProperties": {
        "type": "string",
        "maxLength": 500
      }
    },
    "utm_medium": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1,
      "description": "UTM medium. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain)."
    },
    "utm_source": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1,
      "description": "UTM source. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain)."
    },
    "utm_content": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1,
      "description": "UTM content. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain)."
    },
    "screen_class": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1,
      "description": "Screen class XXL, XL, L, M or S. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain)."
    },
    "utm_campaign": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1,
      "description": "UTM campaign. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain)."
    },
    "referrer_name": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1,
      "description": "Referrer name, usually the hostname. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain)."
    }
  }
}

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "domain_id",
    "from",
    "to",
    "dimension"
  ],
  "properties": {
    "os": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1,
      "description": "Operating system. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain)."
    },
    "to": {
      "type": "string",
      "pattern": "^(\\d{4})-(\\d{2})-(\\d{2})$",
      "description": "Last day, yyyy-mm-dd, whole day included."
    },
    "tz": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_+\\-/]+$",
      "maxLength": 64,
      "minLength": 1,
      "description": "IANA time zone such as Europe/Berlin. Default: the dashboard's time zone."
    },
    "tag": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1,
      "description": "Tag key to filter for."
    },
    "city": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1,
      "description": "City name. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain)."
    },
    "from": {
      "type": "string",
      "pattern": "^(\\d{4})-(\\d{2})-(\\d{2})$",
      "description": "First day, yyyy-mm-dd (in the dashboard time zone unless tz is set)."
    },
    "path": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1,
      "description": "Page path, for example /pricing. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain)."
    },
    "sort": {
      "type": "string",
      "pattern": "^[a-z_]{1,40}$",
      "description": "Field to sort by, for example visitors, views, sessions or bounce_rate."
    },
    "tags": {
      "type": "object",
      "description": "Tag key/value pairs; only results with all pairs match.",
      "propertyNames": {
        "type": "string"
      },
      "additionalProperties": {
        "type": "string",
        "maxLength": 500
      }
    },
    "event": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1,
      "description": "Event name. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain)."
    },
    "limit": {
      "type": "integer",
      "maximum": 100,
      "minimum": 1,
      "description": "Results per page, 1-100 (default 25)."
    },
    "offset": {
      "type": "integer",
      "maximum": 1000000,
      "minimum": 0,
      "description": "Results to skip (default 0). Pass the previous reply's next_offset."
    },
    "search": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1,
      "description": "Only rows whose main field contains this text."
    },
    "browser": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1,
      "description": "Browser. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain)."
    },
    "channel": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1,
      "description": "Traffic channel such as \"Paid Search\" or \"Organic Search\". Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain)."
    },
    "country": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1,
      "description": "ISO 3166 alpha-2 country code such as jp. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain)."
    },
    "pattern": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1,
      "description": "Regular expression that filters and groups pages, for example (?i)^/blog/[^/]+$."
    },
    "hostname": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1,
      "description": "Hostname (useful for rollup views). Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain)."
    },
    "language": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1,
      "description": "ISO 639-1 language code such as en. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain)."
    },
    "platform": {
      "enum": [
        "desktop",
        "mobile",
        "unknown"
      ],
      "type": "string",
      "description": "Platform."
    },
    "referrer": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1,
      "description": "Referrer, usually a URL. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain)."
    },
    "utm_term": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1,
      "description": "UTM term. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain)."
    },
    "dimension": {
      "enum": [
        "country",
        "region",
        "city",
        "language"
      ],
      "type": "string",
      "description": "Which breakdown."
    },
    "direction": {
      "enum": [
        "asc",
        "desc"
      ],
      "type": "string",
      "description": "Sort direction."
    },
    "domain_id": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_-]+$",
      "maxLength": 64,
      "minLength": 1,
      "description": "Pirsch domain (dashboard) id. Get it from pirsch_list_domains."
    },
    "exit_path": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1,
      "description": "Exit page path. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain)."
    },
    "entry_path": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1,
      "description": "Entry page path. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain)."
    },
    "event_meta": {
      "type": "object",
      "description": "Event metadata key/value pairs; only events with all pairs match.",
      "propertyNames": {
        "type": "string"
      },
      "additionalProperties": {
        "type": "string",
        "maxLength": 500
      }
    },
    "utm_medium": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1,
      "description": "UTM medium. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain)."
    },
    "utm_source": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1,
      "description": "UTM source. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain)."
    },
    "utm_content": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1,
      "description": "UTM content. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain)."
    },
    "screen_class": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1,
      "description": "Screen class XXL, XL, L, M or S. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain)."
    },
    "utm_campaign": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1,
      "description": "UTM campaign. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain)."
    },
    "referrer_name": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1,
      "description": "Referrer name, usually the hostname. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain)."
    }
  }
}

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "domain_id",
    "from",
    "to"
  ],
  "properties": {
    "os": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1,
      "description": "Operating system. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain)."
    },
    "to": {
      "type": "string",
      "pattern": "^(\\d{4})-(\\d{2})-(\\d{2})$",
      "description": "Last day, yyyy-mm-dd, whole day included."
    },
    "tz": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_+\\-/]+$",
      "maxLength": 64,
      "minLength": 1,
      "description": "IANA time zone such as Europe/Berlin. Default: the dashboard's time zone."
    },
    "tag": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1,
      "description": "Tag key to filter for."
    },
    "city": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1,
      "description": "City name. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain)."
    },
    "from": {
      "type": "string",
      "pattern": "^(\\d{4})-(\\d{2})-(\\d{2})$",
      "description": "First day, yyyy-mm-dd (in the dashboard time zone unless tz is set)."
    },
    "path": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1,
      "description": "Page path, for example /pricing. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain)."
    },
    "sort": {
      "type": "string",
      "pattern": "^[a-z_]{1,40}$",
      "description": "Field to sort by, for example visitors, views, sessions or bounce_rate."
    },
    "tags": {
      "type": "object",
      "description": "Tag key/value pairs; only results with all pairs match.",
      "propertyNames": {
        "type": "string"
      },
      "additionalProperties": {
        "type": "string",
        "maxLength": 500
      }
    },
    "event": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1,
      "description": "Event name. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain)."
    },
    "limit": {
      "type": "integer",
      "maximum": 100,
      "minimum": 1,
      "description": "Results per page, 1-100 (default 25)."
    },
    "offset": {
      "type": "integer",
      "maximum": 1000000,
      "minimum": 0,
      "description": "Results to skip (default 0). Pass the previous reply's next_offset."
    },
    "search": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1,
      "description": "Only rows whose main field contains this text."
    },
    "browser": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1,
      "description": "Browser. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain)."
    },
    "channel": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1,
      "description": "Traffic channel such as \"Paid Search\" or \"Organic Search\". Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain)."
    },
    "country": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1,
      "description": "ISO 3166 alpha-2 country code such as jp. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain)."
    },
    "pattern": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1,
      "description": "Regular expression that filters and groups pages, for example (?i)^/blog/[^/]+$."
    },
    "hostname": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1,
      "description": "Hostname (useful for rollup views). Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain)."
    },
    "language": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1,
      "description": "ISO 639-1 language code such as en. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain)."
    },
    "platform": {
      "enum": [
        "desktop",
        "mobile",
        "unknown"
      ],
      "type": "string",
      "description": "Platform."
    },
    "referrer": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1,
      "description": "Referrer, usually a URL. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain)."
    },
    "utm_term": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1,
      "description": "UTM term. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain)."
    },
    "direction": {
      "enum": [
        "asc",
        "desc"
      ],
      "type": "string",
      "description": "Sort direction."
    },
    "domain_id": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_-]+$",
      "maxLength": 64,
      "minLength": 1,
      "description": "Pirsch domain (dashboard) id. Get it from pirsch_list_domains."
    },
    "exit_path": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1,
      "description": "Exit page path. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain)."
    },
    "entry_path": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1,
      "description": "Entry page path. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain)."
    },
    "event_meta": {
      "type": "object",
      "description": "Event metadata key/value pairs; only events with all pairs match.",
      "propertyNames": {
        "type": "string"
      },
      "additionalProperties": {
        "type": "string",
        "maxLength": 500
      }
    },
    "utm_medium": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1,
      "description": "UTM medium. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain)."
    },
    "utm_source": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1,
      "description": "UTM source. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain)."
    },
    "utm_content": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1,
      "description": "UTM content. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain)."
    },
    "screen_class": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1,
      "description": "Screen class XXL, XL, L, M or S. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain)."
    },
    "utm_campaign": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1,
      "description": "UTM campaign. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain)."
    },
    "referrer_name": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1,
      "description": "Referrer name, usually the hostname. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain)."
    }
  }
}

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "domain_id",
    "from",
    "to"
  ],
  "properties": {
    "os": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1,
      "description": "Operating system. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain)."
    },
    "to": {
      "type": "string",
      "pattern": "^(\\d{4})-(\\d{2})-(\\d{2})$",
      "description": "Last day, yyyy-mm-dd, whole day included."
    },
    "tz": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_+\\-/]+$",
      "maxLength": 64,
      "minLength": 1,
      "description": "IANA time zone such as Europe/Berlin. Default: the dashboard's time zone."
    },
    "tag": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1,
      "description": "Tag key to filter for."
    },
    "city": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1,
      "description": "City name. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain)."
    },
    "from": {
      "type": "string",
      "pattern": "^(\\d{4})-(\\d{2})-(\\d{2})$",
      "description": "First day, yyyy-mm-dd (in the dashboard time zone unless tz is set)."
    },
    "path": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1,
      "description": "Page path, for example /pricing. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain)."
    },
    "sort": {
      "type": "string",
      "pattern": "^[a-z_]{1,40}$",
      "description": "Field to sort by, for example visitors, views, sessions or bounce_rate."
    },
    "tags": {
      "type": "object",
      "description": "Tag key/value pairs; only results with all pairs match.",
      "propertyNames": {
        "type": "string"
      },
      "additionalProperties": {
        "type": "string",
        "maxLength": 500
      }
    },
    "event": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1,
      "description": "Event name. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain)."
    },
    "limit": {
      "type": "integer",
      "maximum": 100,
      "minimum": 1,
      "description": "Results per page, 1-100 (default 25)."
    },
    "offset": {
      "type": "integer",
      "maximum": 1000000,
      "minimum": 0,
      "description": "Results to skip (default 0). Pass the previous reply's next_offset."
    },
    "search": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1,
      "description": "Only rows whose main field contains this text."
    },
    "browser": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1,
      "description": "Browser. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain)."
    },
    "channel": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1,
      "description": "Traffic channel such as \"Paid Search\" or \"Organic Search\". Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain)."
    },
    "country": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1,
      "description": "ISO 3166 alpha-2 country code such as jp. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain)."
    },
    "pattern": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1,
      "description": "Regular expression that filters and groups pages, for example (?i)^/blog/[^/]+$."
    },
    "hostname": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1,
      "description": "Hostname (useful for rollup views). Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain)."
    },
    "language": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1,
      "description": "ISO 639-1 language code such as en. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain)."
    },
    "platform": {
      "enum": [
        "desktop",
        "mobile",
        "unknown"
      ],
      "type": "string",
      "description": "Platform."
    },
    "referrer": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1,
      "description": "Referrer, usually a URL. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain)."
    },
    "utm_term": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1,
      "description": "UTM term. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain)."
    },
    "direction": {
      "enum": [
        "asc",
        "desc"
      ],
      "type": "string",
      "description": "Sort direction."
    },
    "domain_id": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_-]+$",
      "maxLength": 64,
      "minLength": 1,
      "description": "Pirsch domain (dashboard) id. Get it from pirsch_list_domains."
    },
    "exit_path": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1,
      "description": "Exit page path. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain)."
    },
    "entry_path": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1,
      "description": "Entry page path. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain)."
    },
    "event_meta": {
      "type": "object",
      "description": "Event metadata key/value pairs; only events with all pairs match.",
      "propertyNames": {
        "type": "string"
      },
      "additionalProperties": {
        "type": "string",
        "maxLength": 500
      }
    },
    "utm_medium": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1,
      "description": "UTM medium. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain)."
    },
    "utm_source": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1,
      "description": "UTM source. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain)."
    },
    "utm_content": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1,
      "description": "UTM content. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain)."
    },
    "screen_class": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1,
      "description": "Screen class XXL, XL, L, M or S. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain)."
    },
    "utm_campaign": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1,
      "description": "UTM campaign. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain)."
    },
    "referrer_name": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1,
      "description": "Referrer name, usually the hostname. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain)."
    }
  }
}

Input schema (JSON)

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

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "domain_id",
    "from",
    "to"
  ],
  "properties": {
    "by": {
      "enum": [
        "referrer",
        "channel"
      ],
      "type": "string",
      "description": "referrer (default) or channel."
    },
    "os": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1,
      "description": "Operating system. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain)."
    },
    "to": {
      "type": "string",
      "pattern": "^(\\d{4})-(\\d{2})-(\\d{2})$",
      "description": "Last day, yyyy-mm-dd, whole day included."
    },
    "tz": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_+\\-/]+$",
      "maxLength": 64,
      "minLength": 1,
      "description": "IANA time zone such as Europe/Berlin. Default: the dashboard's time zone."
    },
    "tag": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1,
      "description": "Tag key to filter for."
    },
    "city": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1,
      "description": "City name. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain)."
    },
    "from": {
      "type": "string",
      "pattern": "^(\\d{4})-(\\d{2})-(\\d{2})$",
      "description": "First day, yyyy-mm-dd (in the dashboard time zone unless tz is set)."
    },
    "path": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1,
      "description": "Page path, for example /pricing. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain)."
    },
    "sort": {
      "type": "string",
      "pattern": "^[a-z_]{1,40}$",
      "description": "Field to sort by, for example visitors, views, sessions or bounce_rate."
    },
    "tags": {
      "type": "object",
      "description": "Tag key/value pairs; only results with all pairs match.",
      "propertyNames": {
        "type": "string"
      },
      "additionalProperties": {
        "type": "string",
        "maxLength": 500
      }
    },
    "event": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1,
      "description": "Event name. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain)."
    },
    "limit": {
      "type": "integer",
      "maximum": 100,
      "minimum": 1,
      "description": "Results per page, 1-100 (default 25)."
    },
    "offset": {
      "type": "integer",
      "maximum": 1000000,
      "minimum": 0,
      "description": "Results to skip (default 0). Pass the previous reply's next_offset."
    },
    "search": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1,
      "description": "Only rows whose main field contains this text."
    },
    "browser": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1,
      "description": "Browser. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain)."
    },
    "channel": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1,
      "description": "Traffic channel such as \"Paid Search\" or \"Organic Search\". Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain)."
    },
    "country": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1,
      "description": "ISO 3166 alpha-2 country code such as jp. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain)."
    },
    "pattern": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1,
      "description": "Regular expression that filters and groups pages, for example (?i)^/blog/[^/]+$."
    },
    "hostname": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1,
      "description": "Hostname (useful for rollup views). Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain)."
    },
    "language": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1,
      "description": "ISO 639-1 language code such as en. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain)."
    },
    "platform": {
      "enum": [
        "desktop",
        "mobile",
        "unknown"
      ],
      "type": "string",
      "description": "Platform."
    },
    "referrer": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1,
      "description": "Referrer, usually a URL. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain)."
    },
    "utm_term": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1,
      "description": "UTM term. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain)."
    },
    "direction": {
      "enum": [
        "asc",
        "desc"
      ],
      "type": "string",
      "description": "Sort direction."
    },
    "domain_id": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_-]+$",
      "maxLength": 64,
      "minLength": 1,
      "description": "Pirsch domain (dashboard) id. Get it from pirsch_list_domains."
    },
    "exit_path": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1,
      "description": "Exit page path. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain)."
    },
    "entry_path": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1,
      "description": "Entry page path. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain)."
    },
    "event_meta": {
      "type": "object",
      "description": "Event metadata key/value pairs; only events with all pairs match.",
      "propertyNames": {
        "type": "string"
      },
      "additionalProperties": {
        "type": "string",
        "maxLength": 500
      }
    },
    "utm_medium": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1,
      "description": "UTM medium. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain)."
    },
    "utm_source": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1,
      "description": "UTM source. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain)."
    },
    "utm_content": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1,
      "description": "UTM content. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain)."
    },
    "screen_class": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1,
      "description": "Screen class XXL, XL, L, M or S. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain)."
    },
    "utm_campaign": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1,
      "description": "UTM campaign. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain)."
    },
    "referrer_name": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1,
      "description": "Referrer name, usually the hostname. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain)."
    }
  }
}

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "domain_id",
    "from",
    "to"
  ],
  "properties": {
    "os": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1,
      "description": "Operating system. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain)."
    },
    "to": {
      "type": "string",
      "pattern": "^(\\d{4})-(\\d{2})-(\\d{2})$",
      "description": "Last day, yyyy-mm-dd, whole day included."
    },
    "tz": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_+\\-/]+$",
      "maxLength": 64,
      "minLength": 1,
      "description": "IANA time zone such as Europe/Berlin. Default: the dashboard's time zone."
    },
    "tag": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1,
      "description": "Tag key to filter for."
    },
    "city": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1,
      "description": "City name. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain)."
    },
    "from": {
      "type": "string",
      "pattern": "^(\\d{4})-(\\d{2})-(\\d{2})$",
      "description": "First day, yyyy-mm-dd (in the dashboard time zone unless tz is set)."
    },
    "path": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1,
      "description": "Page path, for example /pricing. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain)."
    },
    "sort": {
      "type": "string",
      "pattern": "^[a-z_]{1,40}$",
      "description": "Field to sort by, for example visitors, views, sessions or bounce_rate."
    },
    "tags": {
      "type": "object",
      "description": "Tag key/value pairs; only results with all pairs match.",
      "propertyNames": {
        "type": "string"
      },
      "additionalProperties": {
        "type": "string",
        "maxLength": 500
      }
    },
    "event": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1,
      "description": "Event name. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain)."
    },
    "limit": {
      "type": "integer",
      "maximum": 100,
      "minimum": 1,
      "description": "Results per page, 1-100 (default 25)."
    },
    "offset": {
      "type": "integer",
      "maximum": 1000000,
      "minimum": 0,
      "description": "Results to skip (default 0). Pass the previous reply's next_offset."
    },
    "search": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1,
      "description": "Only rows whose main field contains this text."
    },
    "browser": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1,
      "description": "Browser. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain)."
    },
    "channel": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1,
      "description": "Traffic channel such as \"Paid Search\" or \"Organic Search\". Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain)."
    },
    "country": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1,
      "description": "ISO 3166 alpha-2 country code such as jp. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain)."
    },
    "pattern": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1,
      "description": "Regular expression that filters and groups pages, for example (?i)^/blog/[^/]+$."
    },
    "hostname": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1,
      "description": "Hostname (useful for rollup views). Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain)."
    },
    "language": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1,
      "description": "ISO 639-1 language code such as en. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain)."
    },
    "platform": {
      "enum": [
        "desktop",
        "mobile",
        "unknown"
      ],
      "type": "string",
      "description": "Platform."
    },
    "referrer": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1,
      "description": "Referrer, usually a URL. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain)."
    },
    "utm_term": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1,
      "description": "UTM term. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain)."
    },
    "direction": {
      "enum": [
        "asc",
        "desc"
      ],
      "type": "string",
      "description": "Sort direction."
    },
    "domain_id": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_-]+$",
      "maxLength": 64,
      "minLength": 1,
      "description": "Pirsch domain (dashboard) id. Get it from pirsch_list_domains."
    },
    "exit_path": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1,
      "description": "Exit page path. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain)."
    },
    "entry_path": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1,
      "description": "Entry page path. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain)."
    },
    "event_meta": {
      "type": "object",
      "description": "Event metadata key/value pairs; only events with all pairs match.",
      "propertyNames": {
        "type": "string"
      },
      "additionalProperties": {
        "type": "string",
        "maxLength": 500
      }
    },
    "utm_medium": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1,
      "description": "UTM medium. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain)."
    },
    "utm_source": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1,
      "description": "UTM source. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain)."
    },
    "utm_content": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1,
      "description": "UTM content. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain)."
    },
    "screen_class": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1,
      "description": "Screen class XXL, XL, L, M or S. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain)."
    },
    "utm_campaign": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1,
      "description": "UTM campaign. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain)."
    },
    "referrer_name": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1,
      "description": "Referrer name, usually the hostname. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain)."
    }
  }
}

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "domain_id",
    "from",
    "to"
  ],
  "properties": {
    "os": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1,
      "description": "Operating system. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain)."
    },
    "to": {
      "type": "string",
      "pattern": "^(\\d{4})-(\\d{2})-(\\d{2})$",
      "description": "Last day, yyyy-mm-dd, whole day included."
    },
    "tz": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_+\\-/]+$",
      "maxLength": 64,
      "minLength": 1,
      "description": "IANA time zone such as Europe/Berlin. Default: the dashboard's time zone."
    },
    "tag": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1,
      "description": "Tag key to filter for."
    },
    "city": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1,
      "description": "City name. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain)."
    },
    "from": {
      "type": "string",
      "pattern": "^(\\d{4})-(\\d{2})-(\\d{2})$",
      "description": "First day, yyyy-mm-dd (in the dashboard time zone unless tz is set)."
    },
    "path": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1,
      "description": "Page path, for example /pricing. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain)."
    },
    "sort": {
      "type": "string",
      "pattern": "^[a-z_]{1,40}$",
      "description": "Field to sort by, for example visitors, views, sessions or bounce_rate."
    },
    "tags": {
      "type": "object",
      "description": "Tag key/value pairs; only results with all pairs match.",
      "propertyNames": {
        "type": "string"
      },
      "additionalProperties": {
        "type": "string",
        "maxLength": 500
      }
    },
    "event": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1,
      "description": "Event name. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain)."
    },
    "limit": {
      "type": "integer",
      "maximum": 100,
      "minimum": 1,
      "description": "Results per page, 1-100 (default 25)."
    },
    "offset": {
      "type": "integer",
      "maximum": 1000000,
      "minimum": 0,
      "description": "Results to skip (default 0). Pass the previous reply's next_offset."
    },
    "search": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1,
      "description": "Only rows whose main field contains this text."
    },
    "browser": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1,
      "description": "Browser. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain)."
    },
    "channel": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1,
      "description": "Traffic channel such as \"Paid Search\" or \"Organic Search\". Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain)."
    },
    "country": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1,
      "description": "ISO 3166 alpha-2 country code such as jp. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain)."
    },
    "pattern": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1,
      "description": "Regular expression that filters and groups pages, for example (?i)^/blog/[^/]+$."
    },
    "hostname": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1,
      "description": "Hostname (useful for rollup views). Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain)."
    },
    "language": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1,
      "description": "ISO 639-1 language code such as en. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain)."
    },
    "platform": {
      "enum": [
        "desktop",
        "mobile",
        "unknown"
      ],
      "type": "string",
      "description": "Platform."
    },
    "referrer": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1,
      "description": "Referrer, usually a URL. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain)."
    },
    "utm_term": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1,
      "description": "UTM term. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain)."
    },
    "direction": {
      "enum": [
        "asc",
        "desc"
      ],
      "type": "string",
      "description": "Sort direction."
    },
    "domain_id": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_-]+$",
      "maxLength": 64,
      "minLength": 1,
      "description": "Pirsch domain (dashboard) id. Get it from pirsch_list_domains."
    },
    "exit_path": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1,
      "description": "Exit page path. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain)."
    },
    "entry_path": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1,
      "description": "Entry page path. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain)."
    },
    "event_meta": {
      "type": "object",
      "description": "Event metadata key/value pairs; only events with all pairs match.",
      "propertyNames": {
        "type": "string"
      },
      "additionalProperties": {
        "type": "string",
        "maxLength": 500
      }
    },
    "utm_medium": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1,
      "description": "UTM medium. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain)."
    },
    "utm_source": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1,
      "description": "UTM source. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain)."
    },
    "utm_content": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1,
      "description": "UTM content. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain)."
    },
    "screen_class": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1,
      "description": "Screen class XXL, XL, L, M or S. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain)."
    },
    "utm_campaign": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1,
      "description": "UTM campaign. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain)."
    },
    "referrer_name": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1,
      "description": "Referrer name, usually the hostname. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain)."
    }
  }
}

Input schema (JSON)

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