Call this server's tools from your browser. Nothing to install.
https://app.pagelens.io/mcp
Bearer token: create an API key at https://app.pagelens.io/#/api and send "Bearer pl_..."
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.
add_annotation
Mark a date on the charts (a release, a campaign, an outage). Needs a write key and member access or higher.
YYYY-MM-DD
Site id from list_sites
This tool isn't marked read-only, so it may change something on the server or in an account you connected.
Tools (23)
add_annotation
Mark a date on the charts (a release, a campaign, an outage). Needs a write key and member access or higher.
Create a goal that counts sessions visiting a page, firing a custom event, or scrolling a page at least `threshold` percent (type scroll). Needs a write key and member access or higher.
Argument
Type
Description
name
string
type*
string
value*
string
Page path (wildcards allowed) or event name
site_id*
string
Site id from list_sites
threshold
integer
For scroll goals: percentage of the page scrolled, e.g. 75
GDPR erasure: permanently delete all events, session replays and the profile of one user on a site. Needs a write key and admin access.
destructive
Argument
Type
Description
site_id*
string
Site id from list_sites
user_id*
string
Identified user id, or "anon:<visitor_id>" for an anonymous visitor
Input schema (JSON)
{
"type": "object",
"required": [
"site_id",
"user_id"
],
"properties": {
"site_id": {
"type": "string",
"description": "Site id from list_sites"
},
"user_id": {
"type": "string",
"description": "Identified user id, or \"anon:<visitor_id>\" for an anonymous visitor"
}
}
}
get_ai_visibility
How the site shows up in AI assistants, per AI company (OpenAI/ChatGPT, Anthropic/Claude, Perplexity, Google/Gemini…) and per page: crawler reads, live fetches while answering a person, human visits sent back, purchases and revenue, robots.txt access, and plain-language findings.
read-only
Argument
Type
Description
to
string
End date YYYY-MM-DD, inclusive (default today)
from
string
Start date YYYY-MM-DD (overrides period)
period
string
Time range (default 7d)
filters
array
Optional filters "dimension:value" (is). Other operators go after the dimension: "page!:/x" is not, "page~:blog" contains, "page!~:blog" does not contain, "page^:/docs" starts with. Dimensions: page, title, hostname, referrer, channel, utm_source, utm_medium, utm_campaign, browser, os, device, screen, country (ISO code), city, language, event, tag
site_id*
string
Site id from list_sites
timezone
string
IANA timezone for days and hours, e.g. Europe/Berlin (default UTC)
segment_id
string
Apply a saved segment (see list_segments); combines with filters
get_bots_and_ai
Bot and AI traffic: AI crawlers (GPTBot, ClaudeBot…), AI assistants fetching pages, search engines, and human visits referred by AI assistants (ChatGPT, Perplexity, Claude…).
read-only
Argument
Type
Description
to
string
End date YYYY-MM-DD, inclusive (default today)
from
string
Start date YYYY-MM-DD (overrides period)
period
string
Time range (default 7d)
filters
array
Optional filters "dimension:value" (is). Other operators go after the dimension: "page!:/x" is not, "page~:blog" contains, "page!~:blog" does not contain, "page^:/docs" starts with. Dimensions: page, title, hostname, referrer, channel, utm_source, utm_medium, utm_campaign, browser, os, device, screen, country (ISO code), city, language, event, tag
site_id*
string
Site id from list_sites
timezone
string
IANA timezone for days and hours, e.g. Europe/Berlin (default UTC)
segment_id
string
Apply a saved segment (see list_segments); combines with filters
Input schema (JSON)
get_breakdown
Top values of one dimension (pages, entry/exit pages, referrers, channels, UTM tags, countries, cities, browsers, OS, devices, languages, custom events, outbound links) with visitors and sessions.
read-only
Argument
Type
Description
to
string
End date YYYY-MM-DD, inclusive (default today)
from
string
Start date YYYY-MM-DD (overrides period)
limit
integer
Rows to return (default 10)
period
string
Time range (default 7d)
search
string
Only values containing this text
filters
array
Optional filters "dimension:value" (is). Other operators go after the dimension: "page!:/x" is not, "page~:blog" contains, "page!~:blog" does not contain, "page^:/docs" starts with. Dimensions: page, title, hostname, referrer, channel, utm_source, utm_medium, utm_campaign, browser, os, device, screen, country (ISO code), city, language, event, tag
site_id*
string
Site id from list_sites
timezone
string
IANA timezone for days and hours, e.g. Europe/Berlin (default UTC)
get_errors
JavaScript errors grouped by message, with occurrences, affected sessions and pages.
read-only
Argument
Type
Description
to
string
End date YYYY-MM-DD, inclusive (default today)
from
string
Start date YYYY-MM-DD (overrides period)
limit
integer
Rows to return (default 10)
period
string
Time range (default 7d)
filters
array
Optional filters "dimension:value" (is). Other operators go after the dimension: "page!:/x" is not, "page~:blog" contains, "page!~:blog" does not contain, "page^:/docs" starts with. Dimensions: page, title, hostname, referrer, channel, utm_source, utm_medium, utm_campaign, browser, os, device, screen, country (ISO code), city, language, event, tag
site_id*
string
Site id from list_sites
timezone
string
IANA timezone for days and hours, e.g. Europe/Berlin (default UTC)
segment_id
string
Apply a saved segment (see list_segments); combines with filters
get_events
Custom events (sent with pagelens.track) and outbound clicks with counts and their properties.
read-only
Argument
Type
Description
to
string
End date YYYY-MM-DD, inclusive (default today)
from
string
Start date YYYY-MM-DD (overrides period)
limit
integer
Rows to return (default 10)
period
string
Time range (default 7d)
filters
array
Optional filters "dimension:value" (is). Other operators go after the dimension: "page!:/x" is not, "page~:blog" contains, "page!~:blog" does not contain, "page^:/docs" starts with. Dimensions: page, title, hostname, referrer, channel, utm_source, utm_medium, utm_campaign, browser, os, device, screen, country (ISO code), city, language, event, tag
site_id*
string
Site id from list_sites
timezone
string
IANA timezone for days and hours, e.g. Europe/Berlin (default UTC)
segment_id
string
Apply a saved segment (see list_segments); combines with filters
get_journeys
Most common page-to-page paths visitors take.
read-only
Argument
Type
Description
to
string
End date YYYY-MM-DD, inclusive (default today)
from
string
Start date YYYY-MM-DD (overrides period)
limit
integer
Rows to return (default 10)
period
string
Time range (default 7d)
filters
array
Optional filters "dimension:value" (is). Other operators go after the dimension: "page!:/x" is not, "page~:blog" contains, "page!~:blog" does not contain, "page^:/docs" starts with. Dimensions: page, title, hostname, referrer, channel, utm_source, utm_medium, utm_campaign, browser, os, device, screen, country (ISO code), city, language, event, tag
site_id*
string
Site id from list_sites
timezone
string
IANA timezone for days and hours, e.g. Europe/Berlin (default UTC)
segment_id
string
Apply a saved segment (see list_segments); combines with filters
Input schema (JSON)
get_overview
Headline metrics (visitors, sessions, pageviews, pages per session, bounce rate, average session duration) for a period, compared with the previous period of the same length, plus a time series.
read-only
Argument
Type
Description
to
string
End date YYYY-MM-DD, inclusive (default today)
from
string
Start date YYYY-MM-DD (overrides period)
period
string
Time range (default 7d)
filters
array
Optional filters "dimension:value" (is). Other operators go after the dimension: "page!:/x" is not, "page~:blog" contains, "page!~:blog" does not contain, "page^:/docs" starts with. Dimensions: page, title, hostname, referrer, channel, utm_source, utm_medium, utm_campaign, browser, os, device, screen, country (ISO code), city, language, event, tag
site_id*
string
Site id from list_sites
timezone
string
IANA timezone for days and hours, e.g. Europe/Berlin (default UTC)
segment_id
string
Apply a saved segment (see list_segments); combines with filters
include_series
get_pages
Per-page metrics: visitors, pageviews, entries, bounce rate and time on page.
read-only
Argument
Type
Description
to
string
End date YYYY-MM-DD, inclusive (default today)
from
string
Start date YYYY-MM-DD (overrides period)
limit
integer
Rows to return (default 10)
period
string
Time range (default 7d)
filters
array
Optional filters "dimension:value" (is). Other operators go after the dimension: "page!:/x" is not, "page~:blog" contains, "page!~:blog" does not contain, "page^:/docs" starts with. Dimensions: page, title, hostname, referrer, channel, utm_source, utm_medium, utm_campaign, browser, os, device, screen, country (ISO code), city, language, event, tag
site_id*
string
Site id from list_sites
timezone
string
IANA timezone for days and hours, e.g. Europe/Berlin (default UTC)
segment_id
string
Apply a saved segment (see list_segments); combines with filters
get_realtime
Visitors online right now (last 5 minutes) and what they are viewing.
Cohort retention of identified users (pagelens.identify): share of each daily or weekly cohort that came back in later periods.
read-only
Argument
Type
Description
unit
string
site_id*
string
Site id from list_sites
timezone
string
IANA timezone for days and hours, e.g. Europe/Berlin (default UTC)
Input schema (JSON)
{
"type": "object",
"required": [
"site_id"
],
"properties": {
"unit": {
"enum": [
"day",
"week"
],
"type": "string"
},
"site_id": {
"type": "string",
"description": "Site id from list_sites"
},
"timezone": {
"type": "string",
"description": "IANA timezone for days and hours, e.g. Europe/Berlin (default UTC)"
}
}
}
get_search_console
Google Search Console data for the site (when connected): clicks, impressions, CTR and average position in Google Search, by query, page, country or device, plus a daily series. Data lags about 2 days.
read-only
Argument
Type
Description
to
string
End date YYYY-MM-DD, inclusive (default today)
from
string
Start date YYYY-MM-DD (overrides period)
limit
integer
Rows to return (default 10)
period
string
Time range (default 7d)
search
string
Only queries (or pages) containing this text
filters
array
Optional filters "dimension:value" (is). Other operators go after the dimension: "page!:/x" is not, "page~:blog" contains, "page!~:blog" does not contain, "page^:/docs" starts with. Dimensions: page, title, hostname, referrer, channel, utm_source, utm_medium, utm_campaign, browser, os, device, screen, country (ISO code), city, language, event, tag
site_id*
string
Site id from list_sites
timezone
string
get_session
Every pageview and event in one session, in order.
Core Web Vitals from real visitors (LCP, INP, CLS, FCP, TTFB) at p50/p75/p90, overall and per page.
read-only
Argument
Type
Description
to
string
End date YYYY-MM-DD, inclusive (default today)
from
string
Start date YYYY-MM-DD (overrides period)
period
string
Time range (default 7d)
filters
array
Optional filters "dimension:value" (is). Other operators go after the dimension: "page!:/x" is not, "page~:blog" contains, "page!~:blog" does not contain, "page^:/docs" starts with. Dimensions: page, title, hostname, referrer, channel, utm_source, utm_medium, utm_campaign, browser, os, device, screen, country (ISO code), city, language, event, tag
site_id*
string
Site id from list_sites
timezone
string
IANA timezone for days and hours, e.g. Europe/Berlin (default UTC)
segment_id
string
Apply a saved segment (see list_segments); combines with filters
Input schema (JSON)
{
"type": "object",
"required": [
"site_id"
],
"properties": {
"to": {
"type": "string",
"description": "End date YYYY-MM-DD, inclusive (default today)"
},
"from": {
"type": "string",
"description": "Start date YYYY-MM-DD (overrides period)"
},
"period": {
"enum": [
"today",
"yesterday",
"24h",
"7d",
"30d",
"90d",
"12m"
],
"type": "string",
"description": "Time range (default 7d)"
},
"filters": {
"type": "array",
"items": {
"type": "string"
},
"description": "Optional filters \"dimension:value\" (is). Other operators go after the dimension: \"page!:/x\" is not, \"page~:blog\" contains, \"page!~:blog\" does not contain, \"page^:/docs\" starts with. Dimensions: page, title, hostname, referrer, channel, utm_source, utm_medium, utm_campaign, browser, os, device, screen, country (ISO code), city, language, event, tag"
},
"site_id": {
"type": "string",
"description": "Site id from list_sites"
},
"timezone": {
"type": "string",
"description": "IANA timezone for days and hours, e.g. Europe/Berlin (default UTC)"
},
"segment_id": {
"type": "string",
"description": "Apply a saved segment (see list_segments); combines with filters"
}
}
}
list_goals
Goals with conversions and conversion rate for the period, compared with the previous period.
read-only
Argument
Type
Description
to
string
End date YYYY-MM-DD, inclusive (default today)
from
string
Start date YYYY-MM-DD (overrides period)
period
string
Time range (default 7d)
filters
array
Optional filters "dimension:value" (is). Other operators go after the dimension: "page!:/x" is not, "page~:blog" contains, "page!~:blog" does not contain, "page^:/docs" starts with. Dimensions: page, title, hostname, referrer, channel, utm_source, utm_medium, utm_campaign, browser, os, device, screen, country (ISO code), city, language, event, tag
site_id*
string
Site id from list_sites
timezone
string
IANA timezone for days and hours, e.g. Europe/Berlin (default UTC)
segment_id
string
Apply a saved segment (see list_segments); combines with filters
Input schema (JSON)
{
"type": "object",
"required": [
"site_id"
],
"properties": {
"to": {
"type": "string",
"description": "End date YYYY-MM-DD, inclusive (default today)"
},
"from": {
"type": "string",
"description": "Start date YYYY-MM-DD (overrides period)"
},
"period": {
"enum": [
"today",
"yesterday",
"24h",
"7d",
"30d",
"90d",
"12m"
],
"type": "string",
"description": "Time range (default 7d)"
},
"filters": {
"type": "array",
"items": {
"type": "string"
},
"description": "Optional filters \"dimension:value\" (is). Other operators go after the dimension: \"page!:/x\" is not, \"page~:blog\" contains, \"page!~:blog\" does not contain, \"page^:/docs\" starts with. Dimensions: page, title, hostname, referrer, channel, utm_source, utm_medium, utm_campaign, browser, os, device, screen, country (ISO code), city, language, event, tag"
},
"site_id": {
"type": "string",
"description": "Site id from list_sites"
},
"timezone": {
"type": "string",
"description": "IANA timezone for days and hours, e.g. Europe/Berlin (default UTC)"
},
"segment_id": {
"type": "string",
"description": "Apply a saved segment (see list_segments); combines with filters"
}
}
}
list_segments
Saved segments (named filter sets such as "Paid traffic" or "Mobile in Germany") that can be applied to any report with segment_id.
Recent sessions with entry/exit page, pages viewed, duration, source, location and device.
read-only
Argument
Type
Description
to
string
End date YYYY-MM-DD, inclusive (default today)
from
string
Start date YYYY-MM-DD (overrides period)
kind
string
limit
integer
Rows to return (default 10)
period
string
Time range (default 7d)
filters
array
Optional filters "dimension:value" (is). Other operators go after the dimension: "page!:/x" is not, "page~:blog" contains, "page!~:blog" does not contain, "page^:/docs" starts with. Dimensions: page, title, hostname, referrer, channel, utm_source, utm_medium, utm_campaign, browser, os, device, screen, country (ISO code), city, language, event, tag
site_id*
string
Site id from list_sites
user_id
string
Only sessions of this identified user
timezone
list_sites
List the websites this key can access, with visitors in the last 24 hours.
read-only
No arguments.
Input schema (JSON)
{
"type": "object",
"properties": {}
}
list_users
Users active in the period: identified users (with traits) and anonymous visitors, with sessions, pageviews and first source.
read-only
Argument
Type
Description
to
string
End date YYYY-MM-DD, inclusive (default today)
from
string
Start date YYYY-MM-DD (overrides period)
kind
string
limit
integer
Rows to return (default 10)
period
string
Time range (default 7d)
search
string
Match user id, name or email
filters
array
Optional filters "dimension:value" (is). Other operators go after the dimension: "page!:/x" is not, "page~:blog" contains, "page!~:blog" does not contain, "page^:/docs" starts with. Dimensions: page, title, hostname, referrer, channel, utm_source, utm_medium, utm_campaign, browser, os, device, screen, country (ISO code), city, language, event, tag
site_id*
string
Site id from list_sites
timezone
run_funnel
Conversion funnel: how many sessions completed each step. Steps are pages (path, * wildcard allowed), custom event names, or a page scrolled at least `threshold` percent (type scroll). mode: ordered (default; other pages may come in between), strict (each step right after the previous one) or flexible (middle steps may be skipped). compare_previous adds the same funnel over the previous period.
read-only
Argument
Type
Description
to
string
End date YYYY-MM-DD, inclusive (default today)
from
string
Start date YYYY-MM-DD (overrides period)
mode
string
steps*
array
period
string
Time range (default 7d)
filters
array
Optional filters "dimension:value" (is). Other operators go after the dimension: "page!:/x" is not, "page~:blog" contains, "page!~:blog" does not contain, "page^:/docs" starts with. Dimensions: page, title, hostname, referrer, channel, utm_source, utm_medium, utm_campaign, browser, os, device, screen, country (ISO code), city, language, event, tag
site_id*
string
Site id from list_sites
Input schema (JSON)
{
"type": "object",
"required": [
"site_id"
],
"properties": {
"to": {
"type": "string",
"description": "End date YYYY-MM-DD, inclusive (default today)"
},
"from": {
"type": "string",
"description": "Start date YYYY-MM-DD (overrides period)"
},
"period": {
"enum": [
"today",
"yesterday",
"24h",
"7d",
"30d",
"90d",
"12m"
],
"type": "string",
"description": "Time range (default 7d)"
},
"filters": {
"type": "array",
"items": {
"type": "string"
},
"description": "Optional filters \"dimension:value\" (is). Other operators go after the dimension: \"page!:/x\" is not, \"page~:blog\" contains, \"page!~:blog\" does not contain, \"page^:/docs\" starts with. Dimensions: page, title, hostname, referrer, channel, utm_source, utm_medium, utm_campaign, browser, os, device, screen, country (ISO code), city, language, event, tag"
},
"site_id": {
"type": "string",
"description": "Site id from list_sites"
},
"timezone": {
"type": "string",
"description": "IANA timezone for days and hours, e.g. Europe/Berlin (default UTC)"
},
"segment_id": {
"type": "string",
"description": "Apply a saved segment (see list_segments); combines with filters"
}
}
}
{
"type": "object",
"required": [
"site_id"
],
"properties": {
"to": {
"type": "string",
"description": "End date YYYY-MM-DD, inclusive (default today)"
},
"from": {
"type": "string",
"description": "Start date YYYY-MM-DD (overrides period)"
},
"period": {
"enum": [
"today",
"yesterday",
"24h",
"7d",
"30d",
"90d",
"12m"
],
"type": "string",
"description": "Time range (default 7d)"
},
"filters": {
"type": "array",
"items": {
"type": "string"
},
"description": "Optional filters \"dimension:value\" (is). Other operators go after the dimension: \"page!:/x\" is not, \"page~:blog\" contains, \"page!~:blog\" does not contain, \"page^:/docs\" starts with. Dimensions: page, title, hostname, referrer, channel, utm_source, utm_medium, utm_campaign, browser, os, device, screen, country (ISO code), city, language, event, tag"
},
"site_id": {
"type": "string",
"description": "Site id from list_sites"
},
"timezone": {
"type": "string",
"description": "IANA timezone for days and hours, e.g. Europe/Berlin (default UTC)"
},
"segment_id": {
"type": "string",
"description": "Apply a saved segment (see list_segments); combines with filters"
}
}
}
dimension*
string
segment_id
string
Apply a saved segment (see list_segments); combines with filters
Input schema (JSON)
{
"type": "object",
"required": [
"site_id",
"dimension"
],
"properties": {
"to": {
"type": "string",
"description": "End date YYYY-MM-DD, inclusive (default today)"
},
"from": {
"type": "string",
"description": "Start date YYYY-MM-DD (overrides period)"
},
"limit": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"description": "Rows to return (default 10)"
},
"period": {
"enum": [
"today",
"yesterday",
"24h",
"7d",
"30d",
"90d",
"12m"
],
"type": "string",
"description": "Time range (default 7d)"
},
"search": {
"type": "string",
"description": "Only values containing this text"
},
"filters": {
"type": "array",
"items": {
"type": "string"
},
"description": "Optional filters \"dimension:value\" (is). Other operators go after the dimension: \"page!:/x\" is not, \"page~:blog\" contains, \"page!~:blog\" does not contain, \"page^:/docs\" starts with. Dimensions: page, title, hostname, referrer, channel, utm_source, utm_medium, utm_campaign, browser, os, device, screen, country (ISO code), city, language, event, tag"
},
"site_id": {
"type": "string",
"description": "Site id from list_sites"
},
"timezone": {
"type": "string",
"description": "IANA timezone for days and hours, e.g. Europe/Berlin (default UTC)"
},
"dimension": {
"enum": [
"page",
"entry",
"exit",
"title",
"hostname",
"referrer",
"channel",
"utm_source",
"utm_medium",
"utm_campaign",
"tag",
"browser",
"os",
"device",
"screen",
"country",
"city",
"language",
"event",
"outbound"
],
"type": "string"
},
"segment_id": {
"type": "string",
"description": "Apply a saved segment (see list_segments); combines with filters"
}
}
}
Input schema (JSON)
{
"type": "object",
"required": [
"site_id"
],
"properties": {
"to": {
"type": "string",
"description": "End date YYYY-MM-DD, inclusive (default today)"
},
"from": {
"type": "string",
"description": "Start date YYYY-MM-DD (overrides period)"
},
"limit": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"description": "Rows to return (default 10)"
},
"period": {
"enum": [
"today",
"yesterday",
"24h",
"7d",
"30d",
"90d",
"12m"
],
"type": "string",
"description": "Time range (default 7d)"
},
"filters": {
"type": "array",
"items": {
"type": "string"
},
"description": "Optional filters \"dimension:value\" (is). Other operators go after the dimension: \"page!:/x\" is not, \"page~:blog\" contains, \"page!~:blog\" does not contain, \"page^:/docs\" starts with. Dimensions: page, title, hostname, referrer, channel, utm_source, utm_medium, utm_campaign, browser, os, device, screen, country (ISO code), city, language, event, tag"
},
"site_id": {
"type": "string",
"description": "Site id from list_sites"
},
"timezone": {
"type": "string",
"description": "IANA timezone for days and hours, e.g. Europe/Berlin (default UTC)"
},
"segment_id": {
"type": "string",
"description": "Apply a saved segment (see list_segments); combines with filters"
}
}
}
Input schema (JSON)
{
"type": "object",
"required": [
"site_id"
],
"properties": {
"to": {
"type": "string",
"description": "End date YYYY-MM-DD, inclusive (default today)"
},
"from": {
"type": "string",
"description": "Start date YYYY-MM-DD (overrides period)"
},
"limit": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"description": "Rows to return (default 10)"
},
"period": {
"enum": [
"today",
"yesterday",
"24h",
"7d",
"30d",
"90d",
"12m"
],
"type": "string",
"description": "Time range (default 7d)"
},
"filters": {
"type": "array",
"items": {
"type": "string"
},
"description": "Optional filters \"dimension:value\" (is). Other operators go after the dimension: \"page!:/x\" is not, \"page~:blog\" contains, \"page!~:blog\" does not contain, \"page^:/docs\" starts with. Dimensions: page, title, hostname, referrer, channel, utm_source, utm_medium, utm_campaign, browser, os, device, screen, country (ISO code), city, language, event, tag"
},
"site_id": {
"type": "string",
"description": "Site id from list_sites"
},
"timezone": {
"type": "string",
"description": "IANA timezone for days and hours, e.g. Europe/Berlin (default UTC)"
},
"segment_id": {
"type": "string",
"description": "Apply a saved segment (see list_segments); combines with filters"
}
}
}
{
"type": "object",
"required": [
"site_id"
],
"properties": {
"to": {
"type": "string",
"description": "End date YYYY-MM-DD, inclusive (default today)"
},
"from": {
"type": "string",
"description": "Start date YYYY-MM-DD (overrides period)"
},
"limit": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"description": "Rows to return (default 10)"
},
"period": {
"enum": [
"today",
"yesterday",
"24h",
"7d",
"30d",
"90d",
"12m"
],
"type": "string",
"description": "Time range (default 7d)"
},
"filters": {
"type": "array",
"items": {
"type": "string"
},
"description": "Optional filters \"dimension:value\" (is). Other operators go after the dimension: \"page!:/x\" is not, \"page~:blog\" contains, \"page!~:blog\" does not contain, \"page^:/docs\" starts with. Dimensions: page, title, hostname, referrer, channel, utm_source, utm_medium, utm_campaign, browser, os, device, screen, country (ISO code), city, language, event, tag"
},
"site_id": {
"type": "string",
"description": "Site id from list_sites"
},
"timezone": {
"type": "string",
"description": "IANA timezone for days and hours, e.g. Europe/Berlin (default UTC)"
},
"segment_id": {
"type": "string",
"description": "Apply a saved segment (see list_segments); combines with filters"
}
}
}
boolean
Include the per-day/hour series (default true)
Input schema (JSON)
{
"type": "object",
"required": [
"site_id"
],
"properties": {
"to": {
"type": "string",
"description": "End date YYYY-MM-DD, inclusive (default today)"
},
"from": {
"type": "string",
"description": "Start date YYYY-MM-DD (overrides period)"
},
"period": {
"enum": [
"today",
"yesterday",
"24h",
"7d",
"30d",
"90d",
"12m"
],
"type": "string",
"description": "Time range (default 7d)"
},
"filters": {
"type": "array",
"items": {
"type": "string"
},
"description": "Optional filters \"dimension:value\" (is). Other operators go after the dimension: \"page!:/x\" is not, \"page~:blog\" contains, \"page!~:blog\" does not contain, \"page^:/docs\" starts with. Dimensions: page, title, hostname, referrer, channel, utm_source, utm_medium, utm_campaign, browser, os, device, screen, country (ISO code), city, language, event, tag"
},
"site_id": {
"type": "string",
"description": "Site id from list_sites"
},
"timezone": {
"type": "string",
"description": "IANA timezone for days and hours, e.g. Europe/Berlin (default UTC)"
},
"segment_id": {
"type": "string",
"description": "Apply a saved segment (see list_segments); combines with filters"
},
"include_series": {
"type": "boolean",
"description": "Include the per-day/hour series (default true)"
}
}
}
Input schema (JSON)
{
"type": "object",
"required": [
"site_id"
],
"properties": {
"to": {
"type": "string",
"description": "End date YYYY-MM-DD, inclusive (default today)"
},
"from": {
"type": "string",
"description": "Start date YYYY-MM-DD (overrides period)"
},
"limit": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"description": "Rows to return (default 10)"
},
"period": {
"enum": [
"today",
"yesterday",
"24h",
"7d",
"30d",
"90d",
"12m"
],
"type": "string",
"description": "Time range (default 7d)"
},
"filters": {
"type": "array",
"items": {
"type": "string"
},
"description": "Optional filters \"dimension:value\" (is). Other operators go after the dimension: \"page!:/x\" is not, \"page~:blog\" contains, \"page!~:blog\" does not contain, \"page^:/docs\" starts with. Dimensions: page, title, hostname, referrer, channel, utm_source, utm_medium, utm_campaign, browser, os, device, screen, country (ISO code), city, language, event, tag"
},
"site_id": {
"type": "string",
"description": "Site id from list_sites"
},
"timezone": {
"type": "string",
"description": "IANA timezone for days and hours, e.g. Europe/Berlin (default UTC)"
},
"segment_id": {
"type": "string",
"description": "Apply a saved segment (see list_segments); combines with filters"
}
}
}
IANA timezone for days and hours, e.g. Europe/Berlin (default UTC)
dimension
string
segment_id
string
Apply a saved segment (see list_segments); combines with filters
Input schema (JSON)
{
"type": "object",
"required": [
"site_id"
],
"properties": {
"to": {
"type": "string",
"description": "End date YYYY-MM-DD, inclusive (default today)"
},
"from": {
"type": "string",
"description": "Start date YYYY-MM-DD (overrides period)"
},
"limit": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"description": "Rows to return (default 10)"
},
"period": {
"enum": [
"today",
"yesterday",
"24h",
"7d",
"30d",
"90d",
"12m"
],
"type": "string",
"description": "Time range (default 7d)"
},
"search": {
"type": "string",
"description": "Only queries (or pages) containing this text"
},
"filters": {
"type": "array",
"items": {
"type": "string"
},
"description": "Optional filters \"dimension:value\" (is). Other operators go after the dimension: \"page!:/x\" is not, \"page~:blog\" contains, \"page!~:blog\" does not contain, \"page^:/docs\" starts with. Dimensions: page, title, hostname, referrer, channel, utm_source, utm_medium, utm_campaign, browser, os, device, screen, country (ISO code), city, language, event, tag"
},
"site_id": {
"type": "string",
"description": "Site id from list_sites"
},
"timezone": {
"type": "string",
"description": "IANA timezone for days and hours, e.g. Europe/Berlin (default UTC)"
},
"dimension": {
"enum": [
"query",
"page",
"country",
"device"
],
"type": "string"
},
"segment_id": {
"type": "string",
"description": "Apply a saved segment (see list_segments); combines with filters"
}
}
}
string
IANA timezone for days and hours, e.g. Europe/Berlin (default UTC)
segment_id
string
Apply a saved segment (see list_segments); combines with filters
Input schema (JSON)
{
"type": "object",
"required": [
"site_id"
],
"properties": {
"to": {
"type": "string",
"description": "End date YYYY-MM-DD, inclusive (default today)"
},
"from": {
"type": "string",
"description": "Start date YYYY-MM-DD (overrides period)"
},
"kind": {
"enum": [
"all",
"engaged",
"bounced",
"errors",
"replay"
],
"type": "string"
},
"limit": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"description": "Rows to return (default 10)"
},
"period": {
"enum": [
"today",
"yesterday",
"24h",
"7d",
"30d",
"90d",
"12m"
],
"type": "string",
"description": "Time range (default 7d)"
},
"filters": {
"type": "array",
"items": {
"type": "string"
},
"description": "Optional filters \"dimension:value\" (is). Other operators go after the dimension: \"page!:/x\" is not, \"page~:blog\" contains, \"page!~:blog\" does not contain, \"page^:/docs\" starts with. Dimensions: page, title, hostname, referrer, channel, utm_source, utm_medium, utm_campaign, browser, os, device, screen, country (ISO code), city, language, event, tag"
},
"site_id": {
"type": "string",
"description": "Site id from list_sites"
},
"user_id": {
"type": "string",
"description": "Only sessions of this identified user"
},
"timezone": {
"type": "string",
"description": "IANA timezone for days and hours, e.g. Europe/Berlin (default UTC)"
},
"segment_id": {
"type": "string",
"description": "Apply a saved segment (see list_segments); combines with filters"
}
}
}
string
IANA timezone for days and hours, e.g. Europe/Berlin (default UTC)
segment_id
string
Apply a saved segment (see list_segments); combines with filters
Input schema (JSON)
{
"type": "object",
"required": [
"site_id"
],
"properties": {
"to": {
"type": "string",
"description": "End date YYYY-MM-DD, inclusive (default today)"
},
"from": {
"type": "string",
"description": "Start date YYYY-MM-DD (overrides period)"
},
"kind": {
"enum": [
"all",
"identified",
"anonymous"
],
"type": "string"
},
"limit": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"description": "Rows to return (default 10)"
},
"period": {
"enum": [
"today",
"yesterday",
"24h",
"7d",
"30d",
"90d",
"12m"
],
"type": "string",
"description": "Time range (default 7d)"
},
"search": {
"type": "string",
"description": "Match user id, name or email"
},
"filters": {
"type": "array",
"items": {
"type": "string"
},
"description": "Optional filters \"dimension:value\" (is). Other operators go after the dimension: \"page!:/x\" is not, \"page~:blog\" contains, \"page!~:blog\" does not contain, \"page^:/docs\" starts with. Dimensions: page, title, hostname, referrer, channel, utm_source, utm_medium, utm_campaign, browser, os, device, screen, country (ISO code), city, language, event, tag"
},
"site_id": {
"type": "string",
"description": "Site id from list_sites"
},
"timezone": {
"type": "string",
"description": "IANA timezone for days and hours, e.g. Europe/Berlin (default UTC)"
},
"segment_id": {
"type": "string",
"description": "Apply a saved segment (see list_segments); combines with filters"
}
}
}
timezone
string
IANA timezone for days and hours, e.g. Europe/Berlin (default UTC)
segment_id
string
Apply a saved segment (see list_segments); combines with filters
compare_previous
boolean
Input schema (JSON)
{
"type": "object",
"required": [
"site_id",
"steps"
],
"properties": {
"to": {
"type": "string",
"description": "End date YYYY-MM-DD, inclusive (default today)"
},
"from": {
"type": "string",
"description": "Start date YYYY-MM-DD (overrides period)"
},
"mode": {
"enum": [
"ordered",
"strict",
"flexible"
],
"type": "string"
},
"steps": {
"type": "array",
"items": {
"type": "object",
"required": [
"type",
"value"
],
"properties": {
"type": {
"enum": [
"page",
"event",
"scroll"
],
"type": "string"
},
"value": {
"type": "string"
},
"threshold": {
"type": "integer"
}
}
},
"maxItems": 10,
"minItems": 2
},
"period": {
"enum": [
"today",
"yesterday",
"24h",
"7d",
"30d",
"90d",
"12m"
],
"type": "string",
"description": "Time range (default 7d)"
},
"filters": {
"type": "array",
"items": {
"type": "string"
},
"description": "Optional filters \"dimension:value\" (is). Other operators go after the dimension: \"page!:/x\" is not, \"page~:blog\" contains, \"page!~:blog\" does not contain, \"page^:/docs\" starts with. Dimensions: page, title, hostname, referrer, channel, utm_source, utm_medium, utm_campaign, browser, os, device, screen, country (ISO code), city, language, event, tag"
},
"site_id": {
"type": "string",
"description": "Site id from list_sites"
},
"timezone": {
"type": "string",
"description": "IANA timezone for days and hours, e.g. Europe/Berlin (default UTC)"
},
"segment_id": {
"type": "string",
"description": "Apply a saved segment (see list_segments); combines with filters"
},
"compare_previous": {
"type": "boolean"
}
}
}