Analytics
| Tool | What it does |
|---|---|
analytics_alert_create | Prefill an Analytics alert form. Ask for the evaluation window when missing; never activate automatically. |
analytics_chart_create | Build an unsaved chart draft on the Analytics canvas. Nothing is saved until the user clicks Save. |
analytics_chart_update | Refine an Analytics chart as an unsaved draft. For chart_id draft, send the complete current chart in patch. |
analytics_dashboard_create | Propose an unsaved dashboard from owned chart copies or templates. Cancel discards it; Save persists it. |
analytics_explain | Explain an Analytics chart definition and displayed results using facts, without inventing causes. |
analytics_query | Query analytics numbers as the user, with the current date, filters and team member scope. |
analytics_registry | Discover analytics metric and breakdown IDs. Call first, then again with an area or q; use only returned IDs. |
analytics_templates | Find Analytics chart, dashboard, goal or list tile templates to adapt. |
goal_create | Prefill an Analytics goal form for review. Never save it automatically. |
analytics_alert_create
Prefill an Analytics alert form. Ask for the evaluation window when missing; never activate automatically.
Prefill an Analytics alert form. Ask for the evaluation window when missing; never activate automatically.
| Endpoint | POST https://api.prospeo.io/api/v2/tools/analytics-alert-create |
| MCP tool | analytics_alert_create on https://mcp.prospeo.io |
| Effect | Changes data. |
| Credits | Free, uses no credits. |
| Permission | No role permission beyond API access. |
| Confirmation | Not needed. |
| Pagination | Returns one page. |
Request
Send POST with your API key in the X-KEY header and a JSON body. Unknown fields and query parameters are rejected. The full JSON Schema is served with the tool list.
| Parameter | Type | Required | Description |
|---|---|---|---|
trigger_type | ”ANALYTICS_METRIC_CONDITION” | No | Default "ANALYTICS_METRIC_CONDITION". |
source | ”analytics” | No | Default "analytics". |
measure | string | Yes | |
filters | array of object | No | |
scope_dimension | string | No | |
scope_value | string or integer | No | |
condition | string (enum) | Yes | One of: ABOVE, BELOW, DROPS_BY_PCT, RISES_BY_PCT, HAS_RESULTS. |
value | number | No | |
window | string | Yes | |
chart_id | string | No | |
sentence | string | Yes | |
sustained_for_days | integer | No | From 1 to any. |
Response
{"ok": true, "summary": "...", "payload": {...}} on success. Errors return {"ok": false, "code", "message", "retryable"}; see error codes.
analytics_chart_create
Build an unsaved chart draft on the Analytics canvas. Nothing is saved until the user clicks Save.
Build an unsaved chart draft on the Analytics canvas. Nothing is saved until the user clicks Save.
| Endpoint | POST https://api.prospeo.io/api/v2/tools/analytics-chart-create |
| MCP tool | analytics_chart_create on https://mcp.prospeo.io |
| Effect | Changes data. |
| Credits | Free, uses no credits. |
| Permission | No role permission beyond API access. |
| Confirmation | Not needed. |
| Pagination | Returns one page. |
Request
Send POST with your API key in the X-KEY header and a JSON body. Unknown fields and query parameters are rejected. The full JSON Schema is served with the tool list.
| Parameter | Type | Required | Description |
|---|---|---|---|
chart | object | Yes | Complete unsaved report; IDs must come from analytics_registry. |
open_in_builder | boolean | No | Default true. |
dashboard_id | string | No |
Response
{"ok": true, "summary": "...", "payload": {...}} on success. Errors return {"ok": false, "code", "message", "retryable"}; see error codes.
analytics_chart_update
Refine an Analytics chart as an unsaved draft. For chart_id draft, send the complete current chart in patch.
Refine an Analytics chart as an unsaved draft. For chart_id draft, send the complete current chart in patch.
| Endpoint | POST https://api.prospeo.io/api/v2/tools/analytics-chart-update |
| MCP tool | analytics_chart_update on https://mcp.prospeo.io |
| Effect | Changes data. |
| Credits | Free, uses no credits. |
| Permission | No role permission beyond API access. |
| Confirmation | Not needed. |
| Pagination | Returns one page. |
Request
Send POST with your API key in the X-KEY header and a JSON body. Unknown fields and query parameters are rejected. The full JSON Schema is served with the tool list.
| Parameter | Type | Required | Description |
|---|---|---|---|
chart_id | string | Yes | |
patch | object | Yes | Complete unsaved report; IDs must come from analytics_registry. |
Response
{"ok": true, "summary": "...", "payload": {...}} on success. Errors return {"ok": false, "code", "message", "retryable"}; see error codes.
analytics_dashboard_create
Propose an unsaved dashboard from owned chart copies or templates. Cancel discards it; Save persists it.
Propose an unsaved dashboard from owned chart copies or templates. Cancel discards it; Save persists it.
| Endpoint | POST https://api.prospeo.io/api/v2/tools/analytics-dashboard-create |
| MCP tool | analytics_dashboard_create on https://mcp.prospeo.io |
| Effect | Changes data. |
| Credits | Free, uses no credits. |
| Permission | No role permission beyond API access. |
| Confirmation | Not needed. |
| Pagination | Returns one page. |
Request
Send POST with your API key in the X-KEY header and a JSON body. Unknown fields and query parameters are rejected. The full JSON Schema is served with the tool list.
| Parameter | Type | Required | Description |
|---|---|---|---|
dashboard | object | Yes | Dashboard draft, never a saved dashboard. |
from_templates | array of string | No | Up to 20 items. |
Response
{"ok": true, "summary": "...", "payload": {...}} on success. Errors return {"ok": false, "code", "message", "retryable"}; see error codes.
analytics_explain
Explain an Analytics chart definition and displayed results using facts, without inventing causes.
Explain an Analytics chart definition and displayed results using facts, without inventing causes.
| Endpoint | POST https://api.prospeo.io/api/v2/tools/analytics-explain |
| MCP tool | analytics_explain on https://mcp.prospeo.io |
| Effect | Reads data. |
| Credits | Free, uses no credits. |
| Permission | No role permission beyond API access. |
| Confirmation | Not needed. |
| Pagination | Returns one page. |
Request
Send POST with your API key in the X-KEY header and a JSON body. Unknown fields and query parameters are rejected. The full JSON Schema is served with the tool list.
| Parameter | Type | Required | Description |
|---|---|---|---|
chart | object | Yes | Complete unsaved report; IDs must come from analytics_registry. |
result_digest | object | Yes | Displayed result facts for explanation; never invent causal claims. |
Response
{"ok": true, "summary": "...", "payload": {...}} on success. Errors return {"ok": false, "code", "message", "retryable"}; see error codes.
analytics_query
Query analytics numbers as the user, with the current date, filters and team member scope.
Query analytics numbers as the user, with the current date, filters and team member scope.
| Endpoint | POST https://api.prospeo.io/api/v2/tools/analytics-query |
| MCP tool | analytics_query on https://mcp.prospeo.io |
| Effect | Reads data. |
| Credits | Free, uses no credits. |
| Permission | No role permission beyond API access. |
| Confirmation | Not needed. |
| Pagination | Returns one page. |
Request
Send POST with your API key in the X-KEY header and a JSON body. Unknown fields and query parameters are rejected. The full JSON Schema is served with the tool list.
| Parameter | Type | Required | Description |
|---|---|---|---|
report | object | Yes | Complete unsaved report; IDs must come from analytics_registry. |
owner_selection | object | No | |
locked_filters | array of object | No | |
timezone | string | No |
Response
{"ok": true, "summary": "...", "payload": {...}} on success. Errors return {"ok": false, "code", "message", "retryable"}; see error codes.
analytics_registry
Discover analytics metric and breakdown IDs. Call first, then again with an area or q; use only returned IDs.
Discover analytics metric and breakdown IDs. Call first, then again with an area or q; use only returned IDs.
| Endpoint | POST https://api.prospeo.io/api/v2/tools/analytics-registry |
| MCP tool | analytics_registry on https://mcp.prospeo.io |
| Effect | Reads data. |
| Credits | Free, uses no credits. |
| Permission | No role permission beyond API access. |
| Confirmation | Not needed. |
| Pagination | Returns one page. |
Request
Send POST with your API key in the X-KEY header and a JSON body. Unknown fields and query parameters are rejected. The full JSON Schema is served with the tool list.
| Parameter | Type | Required | Description |
|---|---|---|---|
area | string | No | |
q | string | No | Length 0 to 200. |
Response
{"ok": true, "summary": "...", "payload": {...}} on success. Errors return {"ok": false, "code", "message", "retryable"}; see error codes.
analytics_templates
Find Analytics chart, dashboard, goal or list tile templates to adapt.
Find Analytics chart, dashboard, goal or list tile templates to adapt.
| Endpoint | POST https://api.prospeo.io/api/v2/tools/analytics-templates |
| MCP tool | analytics_templates on https://mcp.prospeo.io |
| Effect | Reads data. |
| Credits | Free, uses no credits. |
| Permission | No role permission beyond API access. |
| Confirmation | Not needed. |
| Pagination | Returns one page. |
Request
Send POST with your API key in the X-KEY header and a JSON body. Unknown fields and query parameters are rejected. The full JSON Schema is served with the tool list.
| Parameter | Type | Required | Description |
|---|---|---|---|
type | string (enum) | No | One of: chart, dashboard, goal, list_tile. Default "chart". |
q | string | No |
Response
{"ok": true, "summary": "...", "payload": {...}} on success. Errors return {"ok": false, "code", "message", "retryable"}; see error codes.
goal_create
Prefill an Analytics goal form for review. Never save it automatically.
Prefill an Analytics goal form for review. Never save it automatically.
| Endpoint | POST https://api.prospeo.io/api/v2/tools/goal-create |
| MCP tool | goal_create on https://mcp.prospeo.io |
| Effect | Changes data. |
| Credits | Free, uses no credits. |
| Permission | No role permission beyond API access. |
| Confirmation | Not needed. |
| Pagination | Returns one page. |
Request
Send POST with your API key in the X-KEY header and a JSON body. Unknown fields and query parameters are rejected. The full JSON Schema is served with the tool list.
| Parameter | Type | Required | Description |
|---|---|---|---|
name | string | No | |
measure | string | Yes | |
measure_field | string | No | |
filters | array of object | No | |
source_report_id | string | No | |
template_id | string | No | |
audience | string (enum) | No | One of: WHOLE_TEAM, SPECIFIC_PEOPLE. Default "WHOLE_TEAM". |
people | array of object | No | |
team_target | number | No | |
per_person_target | number | No | From 0 to any. |
timeframe | string (enum) | No | One of: DAILY, WEEKLY, MONTHLY, QUARTERLY, YEARLY. Default "WEEKLY". |
direction | string (enum) | No | One of: AT_LEAST, AT_MOST. Default "AT_LEAST". |
Response
{"ok": true, "summary": "...", "payload": {...}} on success. Errors return {"ok": false, "code", "message", "retryable"}; see error codes.