-
Notifications
You must be signed in to change notification settings - Fork 0
Tools
Every tool returns the raw JSON payload from the Takt public API, pretty-printed
as text. On error, the tool returns an MCP error result whose text is
Takt API error (<status> <code>): <message>.
Most tools accept these optional parameters:
| Parameter | Type | Description |
|---|---|---|
period |
enum |
day, 7d, 30d, month, 6mo, 12mo (default 7d). Ignored when both from and to are set. |
from |
string | Start date YYYY-MM-DD (use with to). |
to |
string | End date YYYY-MM-DD (use with from). |
tz |
string | IANA timezone for bucketing, e.g. Europe/Paris. |
List the sites (domains) in an organization. Permission: sites:read.
| Parameter | Type | Required | Description |
|---|---|---|---|
org |
string | no | Org slug. Defaults to TAKT_ORG when unset. |
Top-line metrics: unique visitors, sessions, pageviews, bounce rate, average
visit duration. Permission: stats:read.
| Parameter | Type | Required | Description |
|---|---|---|---|
domain |
string | yes | Site domain, e.g. example.com. |
compareToPrevious |
boolean | no | Also return the previous period of equal length. |
| time filter | no | See above. |
Time series of visitors and pageviews, bucketed by hour or day.
Permission: stats:read.
| Parameter | Type | Required | Description |
|---|---|---|---|
domain |
string | yes | Site domain. |
interval |
enum | no |
hour or day (default day). |
compareToPrevious |
boolean | no | Also return the previous series. |
| time filter | no | See above. |
Top values of a dimension. Permission: stats:read.
| Parameter | Type | Required | Description |
|---|---|---|---|
domain |
string | yes | Site domain. |
dimension |
enum | yes |
pages, sources, countries, regions, cities, devices, browsers, os, utm_source, utm_medium, utm_campaign, entry_page, exit_page. |
country |
string | no | Restrict to one country (ISO-3166 alpha-2, e.g. FR). |
limit |
number | no | Max rows (default 10). |
| time filter | no | See above. |
Visitors active in the last 5 minutes. Permission: stats:read.
| Parameter | Type | Required | Description |
|---|---|---|---|
domain |
string | yes | Site domain. |
Conversions per goal. Permission: stats:read.
| Parameter | Type | Required | Description |
|---|---|---|---|
domain |
string | yes | Site domain. |
| time filter | no | See above. |
Step-by-step funnel reports. Permission: stats:read.
| Parameter | Type | Required | Description |
|---|---|---|---|
domain |
string | yes | Site domain. |
| time filter | no | See above. |
Revenue grouped by currency for a revenue event. Permission: stats:read.
| Parameter | Type | Required | Description |
|---|---|---|---|
domain |
string | yes | Site domain. |
event |
string | yes | Revenue event name, e.g. Purchase. |
| time filter | no | See above. |
List the custom property keys recorded for a given event.
Permission: stats:read.
| Parameter | Type | Required | Description |
|---|---|---|---|
domain |
string | yes | Site domain. |
event |
string | yes | Event name, e.g. Signup. |
| time filter | no | See above. |
Break down a custom property of an event by value (e.g. counts per plan for a
Signup event). Permission: stats:read.
| Parameter | Type | Required | Description |
|---|---|---|---|
domain |
string | yes | Site domain. |
event |
string | yes | Event name. |
key |
string | yes | Custom property key, e.g. plan. |
| time filter | no | See above. |
MIT © VSK Studio · Repository · npm