Read-only web and revenue analytics: visitors, sources, goals, funnels and sales tied to visits.
Maintained bytallybyoutpost.com(verified)Also a maintainer?
Call this server's tools from your browser. Nothing to install.
Your Tally API key as a Bearer token. Make a key on your site's Setup page, under API keys: it reads that one site, and every MCP tool only reads.
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.
A period against the window just before it (previous) or the same dates a year earlier (year): every overview number for both, and the relative change. Changes are null where the site's records don't reach back far enough to compare.
A custom range's last day (YYYY-MM-DD), with from.
A custom range's first day (YYYY-MM-DD), with to. Up to 366 days, not past today.
The site's id. Optional: the API key's site is the one read.
A preset period, in the site's time zone. Leave out for the tool's default, or give from and to instead.
previous (the window just before; the default) or year (the same dates a year earlier).
Visits that match every filter (AND). Each dimension at most once.
Pick your client. Values in capitals, like YOUR_TOKEN, are yours to fill in.
Run in a terminal
claude mcp add --transport http tally https://tallybyoutpost.com/mcp \ --header 'Authorization: Bearer YOUR_TOKEN'
Headers
Authorization (required): Your Tally API key as a Bearer token. Make a key on your site's Setup page, under API keys: it reads that one site, and every MCP tool only reads.A period against the window just before it (previous) or the same dates a year earlier (year): every overview number for both, and the relative change. Changes are null where the site's records don't reach back far enough to compare.
| Argument | Type | Description |
|---|---|---|
| to | string | A custom range's last day (YYYY-MM-DD), with from. |
| from | string | A custom range's first day (YYYY-MM-DD), with to. Up to 366 days, not past today. |
| site | string | The site's id. Optional: the API key's site is the one read. |
| period | string | A preset period, in the site's time zone. Leave out for the tool's default, or give from and to instead. |
| compare | string | previous (the window just before; the default) or year (the same dates a year earlier). |
| filters | object | Visits that match every filter (AND). Each dimension at most once. |
{
"type": "object",
"properties": {
"to": {
"type": "string",
"format": "date",
"description": "A custom range's last day (YYYY-MM-DD), with from."
},
"from": {
"type": "string",
"format": "date",
"description": "A custom range's first day (YYYY-MM-DD), with to. Up to 366 days, not past today."
},
"site": {
"type": "string",
"pattern": "^[a-z2-7]{12}$",
"description": "The site's id. Optional: the API key's site is the one read."
},
"period": {
"enum": [
"today",
"yesterday",
"7d",
"30d",
"12m"
],
"type": "string",
"description": "A preset period, in the site's time zone. Leave out for the tool's default, or give from and to instead."
},
"compare": {
"enum": [
"previous",
"year"
],
"type": "string",
"description": "previous (the window just before; the default) or year (the same dates a year earlier)."
},
"filters": {
"type": "object",
"properties": {
"os": {
"type": "string",
"description": "OS"
},
"city": {
"type": "string",
"description": "City"
},
"exit": {
"type": "string",
"description": "A path, like /pricing."
},
"goal": {
"type": "string",
"description": "A goal's name."
},
"page": {
"type": "string",
"description": "A path, like /pricing."
},
"entry": {
"type": "string",
"description": "A path, like /pricing."
},
"device": {
"type": "string",
"description": "desktop, mobile or tablet."
},
"direct": {
"type": "string",
"description": "typed, shared_link, checkout_return or in_app."
},
"region": {
"type": "string",
"description": "An ISO 3166-2 code with its country, like US-CA."
},
"source": {
"type": "string",
"description": "The visit's source, as shown (Google, x.com); empty for Direct."
},
"browser": {
"type": "string",
"description": "Browser"
},
"channel": {
"type": "string",
"description": "Organic Search, Organic Social, Paid Search, Referral, Direct, Email …"
},
"country": {
"type": "string",
"description": "An ISO 3166-1 alpha-2 code, like DE."
},
"campaign": {
"type": "string",
"description": "Campaign"
},
"referrer": {
"type": "string",
"description": "Referrer"
},
"customers": {
"type": "string",
"description": "\"1\": visitors with a purchase."
},
"utm_medium": {
"type": "string",
"description": "UTM medium"
},
"utm_source": {
"type": "string",
"description": "UTM source"
}
},
"description": "Visits that match every filter (AND). Each dimension at most once.",
"additionalProperties": false
}
},
"additionalProperties": false
}The top values of one dimension (source, channel, page, country, device, campaign …) by distinct visitors, or by revenue, each with its share of visitors and the revenue its visitors brought.
| Argument | Type | Description |
|---|---|---|
| to | string | A custom range's last day (YYYY-MM-DD), with from. |
| from | string | A custom range's first day (YYYY-MM-DD), with to. Up to 366 days, not past today. |
| site | string | The site's id. Optional: the API key's site is the one read. |
| sort | string | Top values by visitors (default) or by revenue. |
| limit | integer | Rows at most (default 10). |
| period | string | A preset period, in the site's time zone. Leave out for the tool's default, or give from and to instead. |
| filters | object | Visits that match every filter (AND). Each dimension at most once. |
| dimension* | string | What to break down by. |
{
"type": "object",
"required": [
"dimension"
],
"properties": {
"to": {
"type": "string",
"format": "date",
"description": "A custom range's last day (YYYY-MM-DD), with from."
},
"from": {
"type": "string",
"format": "date",
"description": "A custom range's first day (YYYY-MM-DD), with to. Up to 366 days, not past today."
},
"site": {
"type": "string",
"pattern": "^[a-z2-7]{12}$",
"description": "The site's id. Optional: the API key's site is the one read."
},
"sort": {
"enum": [
"visitors",
"revenue"
],
"type": "string",
"description": "Top values by visitors (default) or by revenue."
},
"limit": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"description": "Rows at most (default 10)."
},
"period": {
"enum": [
"today",
"yesterday",
"7d",
"30d",
"12m"
],
"type": "string",
"description": "A preset period, in the site's time zone. Leave out for the tool's default, or give from and to instead."
},
"filters": {
"type": "object",
"properties": {
"os": {
"type": "string",
"description": "OS"
},
"city": {
"type": "string",
"description": "City"
},
"exit": {
"type": "string",
"description": "A path, like /pricing."
},
"goal": {
"type": "string",
"description": "A goal's name."
},
"page": {
"type": "string",
"description": "A path, like /pricing."
},
"entry": {
"type": "string",
"description": "A path, like /pricing."
},
"device": {
"type": "string",
"description": "desktop, mobile or tablet."
},
"direct": {
"type": "string",
"description": "typed, shared_link, checkout_return or in_app."
},
"region": {
"type": "string",
"description": "An ISO 3166-2 code with its country, like US-CA."
},
"source": {
"type": "string",
"description": "The visit's source, as shown (Google, x.com); empty for Direct."
},
"browser": {
"type": "string",
"description": "Browser"
},
"channel": {
"type": "string",
"description": "Organic Search, Organic Social, Paid Search, Referral, Direct, Email …"
},
"country": {
"type": "string",
"description": "An ISO 3166-1 alpha-2 code, like DE."
},
"campaign": {
"type": "string",
"description": "Campaign"
},
"referrer": {
"type": "string",
"description": "Referrer"
},
"customers": {
"type": "string",
"description": "\"1\": visitors with a purchase."
},
"utm_medium": {
"type": "string",
"description": "UTM medium"
},
"utm_source": {
"type": "string",
"description": "UTM source"
}
},
"description": "Visits that match every filter (AND). Each dimension at most once.",
"additionalProperties": false
},
"dimension": {
"enum": [
"source",
"channel",
"referrer",
"campaign",
"utm_source",
"utm_medium",
"direct",
"country",
"region",
"city",
"device",
"browser",
"os",
"entry",
"exit",
"page",
"goal"
],
"type": "string",
"description": "What to break down by."
}
},
"additionalProperties": false
}How much of the period's revenue is attributed to a visitor, by method, and the fix-it list for what isn't (with code to paste).
| Argument | Type | Description |
|---|---|---|
| to | string | A custom range's last day (YYYY-MM-DD), with from. |
| from | string | A custom range's first day (YYYY-MM-DD), with to. Up to 366 days, not past today. |
| site | string | The site's id. Optional: the API key's site is the one read. |
| period | string | A preset period, in the site's time zone. Leave out for the tool's default, or give from and to instead. |
{
"type": "object",
"properties": {
"to": {
"type": "string",
"format": "date",
"description": "A custom range's last day (YYYY-MM-DD), with from."
},
"from": {
"type": "string",
"format": "date",
"description": "A custom range's first day (YYYY-MM-DD), with to. Up to 366 days, not past today."
},
"site": {
"type": "string",
"pattern": "^[a-z2-7]{12}$",
"description": "The site's id. Optional: the API key's site is the one read."
},
"period": {
"enum": [
"today",
"yesterday",
"7d",
"30d",
"12m"
],
"type": "string",
"description": "A preset period, in the site's time zone. Leave out for the tool's default, or give from and to instead."
}
},
"additionalProperties": false
}Lifetime value by the source that first brought each customer: customers, revenue, average per customer, renewals and repeat rate, over every payment on record.
| Argument | Type | Description |
|---|---|---|
| site | string | The site's id. Optional: the API key's site is the one read. |
| limit | integer | Rows at most (default 50). |
| filters | object | Visits that match every filter (AND). Each dimension at most once. |
{
"type": "object",
"properties": {
"site": {
"type": "string",
"pattern": "^[a-z2-7]{12}$",
"description": "The site's id. Optional: the API key's site is the one read."
},
"limit": {
"type": "integer",
"maximum": 500,
"minimum": 1,
"description": "Rows at most (default 50)."
},
"filters": {
"type": "object",
"properties": {
"os": {
"type": "string",
"description": "OS"
},
"city": {
"type": "string",
"description": "City"
},
"exit": {
"type": "string",
"description": "A path, like /pricing."
},
"goal": {
"type": "string",
"description": "A goal's name."
},
"page": {
"type": "string",
"description": "A path, like /pricing."
},
"entry": {
"type": "string",
"description": "A path, like /pricing."
},
"device": {
"type": "string",
"description": "desktop, mobile or tablet."
},
"direct": {
"type": "string",
"description": "typed, shared_link, checkout_return or in_app."
},
"region": {
"type": "string",
"description": "An ISO 3166-2 code with its country, like US-CA."
},
"source": {
"type": "string",
"description": "The visit's source, as shown (Google, x.com); empty for Direct."
},
"browser": {
"type": "string",
"description": "Browser"
},
"channel": {
"type": "string",
"description": "Organic Search, Organic Social, Paid Search, Referral, Direct, Email …"
},
"country": {
"type": "string",
"description": "An ISO 3166-1 alpha-2 code, like DE."
},
"campaign": {
"type": "string",
"description": "Campaign"
},
"referrer": {
"type": "string",
"description": "Referrer"
},
"customers": {
"type": "string",
"description": "\"1\": visitors with a purchase."
},
"utm_medium": {
"type": "string",
"description": "UTM medium"
},
"utm_source": {
"type": "string",
"description": "UTM source"
}
},
"description": "Visits that match every filter (AND). Each dimension at most once.",
"additionalProperties": false
}
},
"additionalProperties": false
}How pages are read: views, median reading time, average scroll depth and the share read to the end, per page and overall, and the common entry and exit pages.
| Argument | Type | Description |
|---|---|---|
| to | string | A custom range's last day (YYYY-MM-DD), with from. |
| from | string | A custom range's first day (YYYY-MM-DD), with to. Up to 366 days, not past today. |
| site | string | The site's id. Optional: the API key's site is the one read. |
| limit | integer | Rows at most (default 25). |
| period | string | A preset period, in the site's time zone. Leave out for the tool's default, or give from and to instead. |
| filters | object | Visits that match every filter (AND). Each dimension at most once. |
{
"type": "object",
"properties": {
"to": {
"type": "string",
"format": "date",
"description": "A custom range's last day (YYYY-MM-DD), with from."
},
"from": {
"type": "string",
"format": "date",
"description": "A custom range's first day (YYYY-MM-DD), with to. Up to 366 days, not past today."
},
"site": {
"type": "string",
"pattern": "^[a-z2-7]{12}$",
"description": "The site's id. Optional: the API key's site is the one read."
},
"limit": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"description": "Rows at most (default 25)."
},
"period": {
"enum": [
"today",
"yesterday",
"7d",
"30d",
"12m"
],
"type": "string",
"description": "A preset period, in the site's time zone. Leave out for the tool's default, or give from and to instead."
},
"filters": {
"type": "object",
"properties": {
"os": {
"type": "string",
"description": "OS"
},
"city": {
"type": "string",
"description": "City"
},
"exit": {
"type": "string",
"description": "A path, like /pricing."
},
"goal": {
"type": "string",
"description": "A goal's name."
},
"page": {
"type": "string",
"description": "A path, like /pricing."
},
"entry": {
"type": "string",
"description": "A path, like /pricing."
},
"device": {
"type": "string",
"description": "desktop, mobile or tablet."
},
"direct": {
"type": "string",
"description": "typed, shared_link, checkout_return or in_app."
},
"region": {
"type": "string",
"description": "An ISO 3166-2 code with its country, like US-CA."
},
"source": {
"type": "string",
"description": "The visit's source, as shown (Google, x.com); empty for Direct."
},
"browser": {
"type": "string",
"description": "Browser"
},
"channel": {
"type": "string",
"description": "Organic Search, Organic Social, Paid Search, Referral, Direct, Email …"
},
"country": {
"type": "string",
"description": "An ISO 3166-1 alpha-2 code, like DE."
},
"campaign": {
"type": "string",
"description": "Campaign"
},
"referrer": {
"type": "string",
"description": "Referrer"
},
"customers": {
"type": "string",
"description": "\"1\": visitors with a purchase."
},
"utm_medium": {
"type": "string",
"description": "UTM medium"
},
"utm_source": {
"type": "string",
"description": "UTM source"
}
},
"description": "Visits that match every filter (AND). Each dimension at most once.",
"additionalProperties": false
}
},
"additionalProperties": false
}The site's funnels with each step's visitors, conversion from the step before and from the first, and drop-off; or one funnel with `funnel`.
| Argument | Type | Description |
|---|---|---|
| to | string | A custom range's last day (YYYY-MM-DD), with from. |
| from | string | A custom range's first day (YYYY-MM-DD), with to. Up to 366 days, not past today. |
| site | string | The site's id. Optional: the API key's site is the one read. |
| funnel | string | One funnel's id (from get_goals); leave out for all of them. |
| period | string | A preset period, in the site's time zone. Leave out for the tool's default, or give from and to instead. |
| filters | object | Visits that match every filter (AND). Each dimension at most once. |
{
"type": "object",
"properties": {
"to": {
"type": "string",
"format": "date",
"description": "A custom range's last day (YYYY-MM-DD), with from."
},
"from": {
"type": "string",
"format": "date",
"description": "A custom range's first day (YYYY-MM-DD), with to. Up to 366 days, not past today."
},
"site": {
"type": "string",
"pattern": "^[a-z2-7]{12}$",
"description": "The site's id. Optional: the API key's site is the one read."
},
"funnel": {
"type": "string",
"format": "uuid",
"description": "One funnel's id (from get_goals); leave out for all of them."
},
"period": {
"enum": [
"today",
"yesterday",
"7d",
"30d",
"12m"
],
"type": "string",
"description": "A preset period, in the site's time zone. Leave out for the tool's default, or give from and to instead."
},
"filters": {
"type": "object",
"properties": {
"os": {
"type": "string",
"description": "OS"
},
"city": {
"type": "string",
"description": "City"
},
"exit": {
"type": "string",
"description": "A path, like /pricing."
},
"goal": {
"type": "string",
"description": "A goal's name."
},
"page": {
"type": "string",
"description": "A path, like /pricing."
},
"entry": {
"type": "string",
"description": "A path, like /pricing."
},
"device": {
"type": "string",
"description": "desktop, mobile or tablet."
},
"direct": {
"type": "string",
"description": "typed, shared_link, checkout_return or in_app."
},
"region": {
"type": "string",
"description": "An ISO 3166-2 code with its country, like US-CA."
},
"source": {
"type": "string",
"description": "The visit's source, as shown (Google, x.com); empty for Direct."
},
"browser": {
"type": "string",
"description": "Browser"
},
"channel": {
"type": "string",
"description": "Organic Search, Organic Social, Paid Search, Referral, Direct, Email …"
},
"country": {
"type": "string",
"description": "An ISO 3166-1 alpha-2 code, like DE."
},
"campaign": {
"type": "string",
"description": "Campaign"
},
"referrer": {
"type": "string",
"description": "Referrer"
},
"customers": {
"type": "string",
"description": "\"1\": visitors with a purchase."
},
"utm_medium": {
"type": "string",
"description": "UTM medium"
},
"utm_source": {
"type": "string",
"description": "UTM source"
}
},
"description": "Visits that match every filter (AND). Each dimension at most once.",
"additionalProperties": false
}
},
"additionalProperties": false
}Every goal completed in the period with completions, converting visitors, conversion rate and the revenue of converting visitors; give `goal` for one goal's properties. Lists the site's funnels.
| Argument | Type | Description |
|---|---|---|
| to | string | A custom range's last day (YYYY-MM-DD), with from. |
| from | string | A custom range's first day (YYYY-MM-DD), with to. Up to 366 days, not past today. |
| goal | string | A goal's name, for its properties' breakdown. |
| site | string | The site's id. Optional: the API key's site is the one read. |
| period | string | A preset period, in the site's time zone. Leave out for the tool's default, or give from and to instead. |
| filters | object | Visits that match every filter (AND). Each dimension at most once. |
{
"type": "object",
"properties": {
"to": {
"type": "string",
"format": "date",
"description": "A custom range's last day (YYYY-MM-DD), with from."
},
"from": {
"type": "string",
"format": "date",
"description": "A custom range's first day (YYYY-MM-DD), with to. Up to 366 days, not past today."
},
"goal": {
"type": "string",
"description": "A goal's name, for its properties' breakdown."
},
"site": {
"type": "string",
"pattern": "^[a-z2-7]{12}$",
"description": "The site's id. Optional: the API key's site is the one read."
},
"period": {
"enum": [
"today",
"yesterday",
"7d",
"30d",
"12m"
],
"type": "string",
"description": "A preset period, in the site's time zone. Leave out for the tool's default, or give from and to instead."
},
"filters": {
"type": "object",
"properties": {
"os": {
"type": "string",
"description": "OS"
},
"city": {
"type": "string",
"description": "City"
},
"exit": {
"type": "string",
"description": "A path, like /pricing."
},
"goal": {
"type": "string",
"description": "A goal's name."
},
"page": {
"type": "string",
"description": "A path, like /pricing."
},
"entry": {
"type": "string",
"description": "A path, like /pricing."
},
"device": {
"type": "string",
"description": "desktop, mobile or tablet."
},
"direct": {
"type": "string",
"description": "typed, shared_link, checkout_return or in_app."
},
"region": {
"type": "string",
"description": "An ISO 3166-2 code with its country, like US-CA."
},
"source": {
"type": "string",
"description": "The visit's source, as shown (Google, x.com); empty for Direct."
},
"browser": {
"type": "string",
"description": "Browser"
},
"channel": {
"type": "string",
"description": "Organic Search, Organic Social, Paid Search, Referral, Direct, Email …"
},
"country": {
"type": "string",
"description": "An ISO 3166-1 alpha-2 code, like DE."
},
"campaign": {
"type": "string",
"description": "Campaign"
},
"referrer": {
"type": "string",
"description": "Referrer"
},
"customers": {
"type": "string",
"description": "\"1\": visitors with a purchase."
},
"utm_medium": {
"type": "string",
"description": "UTM medium"
},
"utm_source": {
"type": "string",
"description": "UTM source"
}
},
"description": "Visits that match every filter (AND). Each dimension at most once.",
"additionalProperties": false
}
},
"additionalProperties": false
}Visitors, pageviews, visits, median engaged time and, when payments are connected, net revenue, sales, refunds, conversion rate and revenue per visitor, for a period and the window before it, with the change between them. Also the visitors live now.
| Argument | Type | Description |
|---|---|---|
| to | string | A custom range's last day (YYYY-MM-DD), with from. |
| from | string | A custom range's first day (YYYY-MM-DD), with to. Up to 366 days, not past today. |
| site | string | The site's id. Optional: the API key's site is the one read. |
| period | string | A preset period, in the site's time zone. Leave out for the tool's default, or give from and to instead. |
| filters | object | Visits that match every filter (AND). Each dimension at most once. |
{
"type": "object",
"properties": {
"to": {
"type": "string",
"format": "date",
"description": "A custom range's last day (YYYY-MM-DD), with from."
},
"from": {
"type": "string",
"format": "date",
"description": "A custom range's first day (YYYY-MM-DD), with to. Up to 366 days, not past today."
},
"site": {
"type": "string",
"pattern": "^[a-z2-7]{12}$",
"description": "The site's id. Optional: the API key's site is the one read."
},
"period": {
"enum": [
"today",
"yesterday",
"7d",
"30d",
"12m"
],
"type": "string",
"description": "A preset period, in the site's time zone. Leave out for the tool's default, or give from and to instead."
},
"filters": {
"type": "object",
"properties": {
"os": {
"type": "string",
"description": "OS"
},
"city": {
"type": "string",
"description": "City"
},
"exit": {
"type": "string",
"description": "A path, like /pricing."
},
"goal": {
"type": "string",
"description": "A goal's name."
},
"page": {
"type": "string",
"description": "A path, like /pricing."
},
"entry": {
"type": "string",
"description": "A path, like /pricing."
},
"device": {
"type": "string",
"description": "desktop, mobile or tablet."
},
"direct": {
"type": "string",
"description": "typed, shared_link, checkout_return or in_app."
},
"region": {
"type": "string",
"description": "An ISO 3166-2 code with its country, like US-CA."
},
"source": {
"type": "string",
"description": "The visit's source, as shown (Google, x.com); empty for Direct."
},
"browser": {
"type": "string",
"description": "Browser"
},
"channel": {
"type": "string",
"description": "Organic Search, Organic Social, Paid Search, Referral, Direct, Email …"
},
"country": {
"type": "string",
"description": "An ISO 3166-1 alpha-2 code, like DE."
},
"campaign": {
"type": "string",
"description": "Campaign"
},
"referrer": {
"type": "string",
"description": "Referrer"
},
"customers": {
"type": "string",
"description": "\"1\": visitors with a purchase."
},
"utm_medium": {
"type": "string",
"description": "UTM medium"
},
"utm_source": {
"type": "string",
"description": "UTM source"
}
},
"description": "Visits that match every filter (AND). Each dimension at most once.",
"additionalProperties": false
}
},
"additionalProperties": false
}Visits, sales and revenue by weekday and hour in the site's time zone, and the busiest three hours when the data is enough to say.
| Argument | Type | Description |
|---|---|---|
| to | string | A custom range's last day (YYYY-MM-DD), with from. |
| from | string | A custom range's first day (YYYY-MM-DD), with to. Up to 366 days, not past today. |
| site | string | The site's id. Optional: the API key's site is the one read. |
| period | string | A preset period, in the site's time zone. Leave out for the tool's default, or give from and to instead. |
| filters | object | Visits that match every filter (AND). Each dimension at most once. |
{
"type": "object",
"properties": {
"to": {
"type": "string",
"format": "date",
"description": "A custom range's last day (YYYY-MM-DD), with from."
},
"from": {
"type": "string",
"format": "date",
"description": "A custom range's first day (YYYY-MM-DD), with to. Up to 366 days, not past today."
},
"site": {
"type": "string",
"pattern": "^[a-z2-7]{12}$",
"description": "The site's id. Optional: the API key's site is the one read."
},
"period": {
"enum": [
"today",
"yesterday",
"7d",
"30d",
"12m"
],
"type": "string",
"description": "A preset period, in the site's time zone. Leave out for the tool's default, or give from and to instead."
},
"filters": {
"type": "object",
"properties": {
"os": {
"type": "string",
"description": "OS"
},
"city": {
"type": "string",
"description": "City"
},
"exit": {
"type": "string",
"description": "A path, like /pricing."
},
"goal": {
"type": "string",
"description": "A goal's name."
},
"page": {
"type": "string",
"description": "A path, like /pricing."
},
"entry": {
"type": "string",
"description": "A path, like /pricing."
},
"device": {
"type": "string",
"description": "desktop, mobile or tablet."
},
"direct": {
"type": "string",
"description": "typed, shared_link, checkout_return or in_app."
},
"region": {
"type": "string",
"description": "An ISO 3166-2 code with its country, like US-CA."
},
"source": {
"type": "string",
"description": "The visit's source, as shown (Google, x.com); empty for Direct."
},
"browser": {
"type": "string",
"description": "Browser"
},
"channel": {
"type": "string",
"description": "Organic Search, Organic Social, Paid Search, Referral, Direct, Email …"
},
"country": {
"type": "string",
"description": "An ISO 3166-1 alpha-2 code, like DE."
},
"campaign": {
"type": "string",
"description": "Campaign"
},
"referrer": {
"type": "string",
"description": "Referrer"
},
"customers": {
"type": "string",
"description": "\"1\": visitors with a purchase."
},
"utm_medium": {
"type": "string",
"description": "UTM medium"
},
"utm_source": {
"type": "string",
"description": "UTM source"
}
},
"description": "Visits that match every filter (AND). Each dimension at most once.",
"additionalProperties": false
}
},
"additionalProperties": false
}How buyers got there: time from first visit to purchase, visits and pages before paying, first-touch to credited-source flows, and the pages buyers saw before paying.
| Argument | Type | Description |
|---|---|---|
| to | string | A custom range's last day (YYYY-MM-DD), with from. |
| from | string | A custom range's first day (YYYY-MM-DD), with to. Up to 366 days, not past today. |
| site | string | The site's id. Optional: the API key's site is the one read. |
| limit | integer | Rows at most (default 8). |
| period | string | A preset period, in the site's time zone. Leave out for the tool's default, or give from and to instead. |
| filters | object | Visits that match every filter (AND). Each dimension at most once. |
{
"type": "object",
"properties": {
"to": {
"type": "string",
"format": "date",
"description": "A custom range's last day (YYYY-MM-DD), with from."
},
"from": {
"type": "string",
"format": "date",
"description": "A custom range's first day (YYYY-MM-DD), with to. Up to 366 days, not past today."
},
"site": {
"type": "string",
"pattern": "^[a-z2-7]{12}$",
"description": "The site's id. Optional: the API key's site is the one read."
},
"limit": {
"type": "integer",
"maximum": 50,
"minimum": 1,
"description": "Rows at most (default 8)."
},
"period": {
"enum": [
"today",
"yesterday",
"7d",
"30d",
"12m"
],
"type": "string",
"description": "A preset period, in the site's time zone. Leave out for the tool's default, or give from and to instead."
},
"filters": {
"type": "object",
"properties": {
"os": {
"type": "string",
"description": "OS"
},
"city": {
"type": "string",
"description": "City"
},
"exit": {
"type": "string",
"description": "A path, like /pricing."
},
"goal": {
"type": "string",
"description": "A goal's name."
},
"page": {
"type": "string",
"description": "A path, like /pricing."
},
"entry": {
"type": "string",
"description": "A path, like /pricing."
},
"device": {
"type": "string",
"description": "desktop, mobile or tablet."
},
"direct": {
"type": "string",
"description": "typed, shared_link, checkout_return or in_app."
},
"region": {
"type": "string",
"description": "An ISO 3166-2 code with its country, like US-CA."
},
"source": {
"type": "string",
"description": "The visit's source, as shown (Google, x.com); empty for Direct."
},
"browser": {
"type": "string",
"description": "Browser"
},
"channel": {
"type": "string",
"description": "Organic Search, Organic Social, Paid Search, Referral, Direct, Email …"
},
"country": {
"type": "string",
"description": "An ISO 3166-1 alpha-2 code, like DE."
},
"campaign": {
"type": "string",
"description": "Campaign"
},
"referrer": {
"type": "string",
"description": "Referrer"
},
"customers": {
"type": "string",
"description": "\"1\": visitors with a purchase."
},
"utm_medium": {
"type": "string",
"description": "UTM medium"
},
"utm_source": {
"type": "string",
"description": "UTM source"
}
},
"description": "Visits that match every filter (AND). Each dimension at most once.",
"additionalProperties": false
}
},
"additionalProperties": false
}Who is on the site in the last five minutes (page, place, source, device) and the sales of the last hour.
| Argument | Type | Description |
|---|---|---|
| site | string | The site's id. Optional: the API key's site is the one read. |
| limit | integer | Rows at most (default 100). |
| filters | object | Visits that match every filter (AND). Each dimension at most once. |
{
"type": "object",
"properties": {
"site": {
"type": "string",
"pattern": "^[a-z2-7]{12}$",
"description": "The site's id. Optional: the API key's site is the one read."
},
"limit": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"description": "Rows at most (default 100)."
},
"filters": {
"type": "object",
"properties": {
"os": {
"type": "string",
"description": "OS"
},
"city": {
"type": "string",
"description": "City"
},
"exit": {
"type": "string",
"description": "A path, like /pricing."
},
"goal": {
"type": "string",
"description": "A goal's name."
},
"page": {
"type": "string",
"description": "A path, like /pricing."
},
"entry": {
"type": "string",
"description": "A path, like /pricing."
},
"device": {
"type": "string",
"description": "desktop, mobile or tablet."
},
"direct": {
"type": "string",
"description": "typed, shared_link, checkout_return or in_app."
},
"region": {
"type": "string",
"description": "An ISO 3166-2 code with its country, like US-CA."
},
"source": {
"type": "string",
"description": "The visit's source, as shown (Google, x.com); empty for Direct."
},
"browser": {
"type": "string",
"description": "Browser"
},
"channel": {
"type": "string",
"description": "Organic Search, Organic Social, Paid Search, Referral, Direct, Email …"
},
"country": {
"type": "string",
"description": "An ISO 3166-1 alpha-2 code, like DE."
},
"campaign": {
"type": "string",
"description": "Campaign"
},
"referrer": {
"type": "string",
"description": "Referrer"
},
"customers": {
"type": "string",
"description": "\"1\": visitors with a purchase."
},
"utm_medium": {
"type": "string",
"description": "UTM medium"
},
"utm_source": {
"type": "string",
"description": "UTM source"
}
},
"description": "Visits that match every filter (AND). Each dimension at most once.",
"additionalProperties": false
}
},
"additionalProperties": false
}One payment's receipt: the evidence chain that ties it to a visit (first visit, visits before paying, the credited visit, the handle that matched and where), every provider id, and the payment it follows from.
| Argument | Type | Description |
|---|---|---|
| site | string | The site's id. Optional: the API key's site is the one read. |
| payment_id* | string | The payment's id, from list_sales. |
{
"type": "object",
"required": [
"payment_id"
],
"properties": {
"site": {
"type": "string",
"pattern": "^[a-z2-7]{12}$",
"description": "The site's id. Optional: the API key's site is the one read."
},
"payment_id": {
"type": "string",
"format": "uuid",
"description": "The payment's id, from list_sales."
}
},
"additionalProperties": false
}One visitor's whole journey: every visit with its pages, engaged time, goals and outbound clicks, their payments, first touch and the touch credited with the sale.
| Argument | Type | Description |
|---|---|---|
| site | string | The site's id. Optional: the API key's site is the one read. |
| cursor | string | The next_cursor of the previous page, to read on. |
| visitor* | string | A visitor's key from list_visitors (a visit's session id on a cookieless site). |
{
"type": "object",
"required": [
"visitor"
],
"properties": {
"site": {
"type": "string",
"pattern": "^[a-z2-7]{12}$",
"description": "The site's id. Optional: the API key's site is the one read."
},
"cursor": {
"type": "string",
"description": "The next_cursor of the previous page, to read on."
},
"visitor": {
"type": "string",
"description": "A visitor's key from list_visitors (a visit's session id on a cookieless site)."
}
},
"additionalProperties": false
}Payments newest first, each with its amount as charged and in US dollars, whether it is linked to a visitor, how (method and confidence), and why not when it isn't. Filter to unlinked payments or refunds.
| Argument | Type | Description |
|---|---|---|
| show | string | Which payments (default all). |
| site | string | The site's id. Optional: the API key's site is the one read. |
| limit | integer | Rows at most (default 50). |
| cursor | string | The next_cursor of the previous page, to read on. |
{
"type": "object",
"properties": {
"show": {
"enum": [
"all",
"unlinked",
"refunds"
],
"type": "string",
"description": "Which payments (default all)."
},
"site": {
"type": "string",
"pattern": "^[a-z2-7]{12}$",
"description": "The site's id. Optional: the API key's site is the one read."
},
"limit": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"description": "Rows at most (default 50)."
},
"cursor": {
"type": "string",
"description": "The next_cursor of the previous page, to read on."
}
},
"additionalProperties": false
}The site this API key reads: its id, name, domain, time zone and how visitors are counted (cookie, cookieless or consent).
| Argument | Type | Description |
|---|---|---|
| site | string | The site's id. Optional: the API key's site is the one read. |
{
"type": "object",
"properties": {
"site": {
"type": "string",
"pattern": "^[a-z2-7]{12}$",
"description": "The site's id. Optional: the API key's site is the one read."
}
},
"additionalProperties": false
}Visitors (visits on a cookieless site) of a period, most recent first or by revenue or likely to buy, with visits, pages, engaged time per visit, revenue and their latest visit.
| Argument | Type | Description |
|---|---|---|
| to | string | A custom range's last day (YYYY-MM-DD), with from. |
| from | string | A custom range's first day (YYYY-MM-DD), with to. Up to 366 days, not past today. |
| site | string | The site's id. Optional: the API key's site is the one read. |
| sort | string | recent (default), revenue, or likely to buy. |
| limit | integer | Rows at most (default 25). |
| cursor | string | The next_cursor of the previous page, to read on. |
| period | string | A preset period, in the site's time zone. Leave out for the tool's default, or give from and to instead. |
| filters | object | Visits that match every filter (AND). Each dimension at most once. |
| customers_only | boolean | Only visitors with a purchase. |
{
"type": "object",
"properties": {
"to": {
"type": "string",
"format": "date",
"description": "A custom range's last day (YYYY-MM-DD), with from."
},
"from": {
"type": "string",
"format": "date",
"description": "A custom range's first day (YYYY-MM-DD), with to. Up to 366 days, not past today."
},
"site": {
"type": "string",
"pattern": "^[a-z2-7]{12}$",
"description": "The site's id. Optional: the API key's site is the one read."
},
"sort": {
"enum": [
"recent",
"revenue",
"likely"
],
"type": "string",
"description": "recent (default), revenue, or likely to buy."
},
"limit": {
"type": "integer",
"maximum": 25,
"minimum": 1,
"description": "Rows at most (default 25)."
},
"cursor": {
"type": "string",
"description": "The next_cursor of the previous page, to read on."
},
"period": {
"enum": [
"today",
"yesterday",
"7d",
"30d",
"12m"
],
"type": "string",
"description": "A preset period, in the site's time zone. Leave out for the tool's default, or give from and to instead."
},
"filters": {
"type": "object",
"properties": {
"os": {
"type": "string",
"description": "OS"
},
"city": {
"type": "string",
"description": "City"
},
"exit": {
"type": "string",
"description": "A path, like /pricing."
},
"goal": {
"type": "string",
"description": "A goal's name."
},
"page": {
"type": "string",
"description": "A path, like /pricing."
},
"entry": {
"type": "string",
"description": "A path, like /pricing."
},
"device": {
"type": "string",
"description": "desktop, mobile or tablet."
},
"direct": {
"type": "string",
"description": "typed, shared_link, checkout_return or in_app."
},
"region": {
"type": "string",
"description": "An ISO 3166-2 code with its country, like US-CA."
},
"source": {
"type": "string",
"description": "The visit's source, as shown (Google, x.com); empty for Direct."
},
"browser": {
"type": "string",
"description": "Browser"
},
"channel": {
"type": "string",
"description": "Organic Search, Organic Social, Paid Search, Referral, Direct, Email …"
},
"country": {
"type": "string",
"description": "An ISO 3166-1 alpha-2 code, like DE."
},
"campaign": {
"type": "string",
"description": "Campaign"
},
"referrer": {
"type": "string",
"description": "Referrer"
},
"customers": {
"type": "string",
"description": "\"1\": visitors with a purchase."
},
"utm_medium": {
"type": "string",
"description": "UTM medium"
},
"utm_source": {
"type": "string",
"description": "UTM source"
}
},
"description": "Visits that match every filter (AND). Each dimension at most once.",
"additionalProperties": false
},
"customers_only": {
"type": "boolean",
"description": "Only visitors with a purchase."
}
},
"additionalProperties": false
}We read every tool's name, description and inputs the way the model will, looking for instructions hidden from you. A clean result means no warning signs, not a guarantee. Scanned Nov 18, 2026.