Skip to Content

Analytics

ToolWhat it does
analytics_alert_createPrefill an Analytics alert form. Ask for the evaluation window when missing; never activate automatically.
analytics_chart_createBuild an unsaved chart draft on the Analytics canvas. Nothing is saved until the user clicks Save.
analytics_chart_updateRefine an Analytics chart as an unsaved draft. For chart_id draft, send the complete current chart in patch.
analytics_dashboard_createPropose an unsaved dashboard from owned chart copies or templates. Cancel discards it; Save persists it.
analytics_explainExplain an Analytics chart definition and displayed results using facts, without inventing causes.
analytics_queryQuery analytics numbers as the user, with the current date, filters and team member scope.
analytics_registryDiscover analytics metric and breakdown IDs. Call first, then again with an area or q; use only returned IDs.
analytics_templatesFind Analytics chart, dashboard, goal or list tile templates to adapt.
goal_createPrefill 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.

EndpointPOST https://api.prospeo.io/api/v2/tools/analytics-alert-create
MCP toolanalytics_alert_create on https://mcp.prospeo.io
EffectChanges data.
CreditsFree, uses no credits.
PermissionNo role permission beyond API access.
ConfirmationNot needed.
PaginationReturns 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.

ParameterTypeRequiredDescription
trigger_type”ANALYTICS_METRIC_CONDITION”NoDefault "ANALYTICS_METRIC_CONDITION".
source”analytics”NoDefault "analytics".
measurestringYes
filtersarray of objectNo
scope_dimensionstringNo
scope_valuestring or integerNo
conditionstring (enum)YesOne of: ABOVE, BELOW, DROPS_BY_PCT, RISES_BY_PCT, HAS_RESULTS.
valuenumberNo
windowstringYes
chart_idstringNo
sentencestringYes
sustained_for_daysintegerNoFrom 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.

EndpointPOST https://api.prospeo.io/api/v2/tools/analytics-chart-create
MCP toolanalytics_chart_create on https://mcp.prospeo.io
EffectChanges data.
CreditsFree, uses no credits.
PermissionNo role permission beyond API access.
ConfirmationNot needed.
PaginationReturns 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.

ParameterTypeRequiredDescription
chartobjectYesComplete unsaved report; IDs must come from analytics_registry.
open_in_builderbooleanNoDefault true.
dashboard_idstringNo

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.

EndpointPOST https://api.prospeo.io/api/v2/tools/analytics-chart-update
MCP toolanalytics_chart_update on https://mcp.prospeo.io
EffectChanges data.
CreditsFree, uses no credits.
PermissionNo role permission beyond API access.
ConfirmationNot needed.
PaginationReturns 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.

ParameterTypeRequiredDescription
chart_idstringYes
patchobjectYesComplete 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.

EndpointPOST https://api.prospeo.io/api/v2/tools/analytics-dashboard-create
MCP toolanalytics_dashboard_create on https://mcp.prospeo.io
EffectChanges data.
CreditsFree, uses no credits.
PermissionNo role permission beyond API access.
ConfirmationNot needed.
PaginationReturns 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.

ParameterTypeRequiredDescription
dashboardobjectYesDashboard draft, never a saved dashboard.
from_templatesarray of stringNoUp 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.

EndpointPOST https://api.prospeo.io/api/v2/tools/analytics-explain
MCP toolanalytics_explain on https://mcp.prospeo.io
EffectReads data.
CreditsFree, uses no credits.
PermissionNo role permission beyond API access.
ConfirmationNot needed.
PaginationReturns 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.

ParameterTypeRequiredDescription
chartobjectYesComplete unsaved report; IDs must come from analytics_registry.
result_digestobjectYesDisplayed 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.

EndpointPOST https://api.prospeo.io/api/v2/tools/analytics-query
MCP toolanalytics_query on https://mcp.prospeo.io
EffectReads data.
CreditsFree, uses no credits.
PermissionNo role permission beyond API access.
ConfirmationNot needed.
PaginationReturns 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.

ParameterTypeRequiredDescription
reportobjectYesComplete unsaved report; IDs must come from analytics_registry.
owner_selectionobjectNo
locked_filtersarray of objectNo
timezonestringNo

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.

EndpointPOST https://api.prospeo.io/api/v2/tools/analytics-registry
MCP toolanalytics_registry on https://mcp.prospeo.io
EffectReads data.
CreditsFree, uses no credits.
PermissionNo role permission beyond API access.
ConfirmationNot needed.
PaginationReturns 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.

ParameterTypeRequiredDescription
areastringNo
qstringNoLength 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.

EndpointPOST https://api.prospeo.io/api/v2/tools/analytics-templates
MCP toolanalytics_templates on https://mcp.prospeo.io
EffectReads data.
CreditsFree, uses no credits.
PermissionNo role permission beyond API access.
ConfirmationNot needed.
PaginationReturns 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.

ParameterTypeRequiredDescription
typestring (enum)NoOne of: chart, dashboard, goal, list_tile. Default "chart".
qstringNo

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.

EndpointPOST https://api.prospeo.io/api/v2/tools/goal-create
MCP toolgoal_create on https://mcp.prospeo.io
EffectChanges data.
CreditsFree, uses no credits.
PermissionNo role permission beyond API access.
ConfirmationNot needed.
PaginationReturns 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.

ParameterTypeRequiredDescription
namestringNo
measurestringYes
measure_fieldstringNo
filtersarray of objectNo
source_report_idstringNo
template_idstringNo
audiencestring (enum)NoOne of: WHOLE_TEAM, SPECIFIC_PEOPLE. Default "WHOLE_TEAM".
peoplearray of objectNo
team_targetnumberNo
per_person_targetnumberNoFrom 0 to any.
timeframestring (enum)NoOne of: DAILY, WEEKLY, MONTHLY, QUARTERLY, YEARLY. Default "WEEKLY".
directionstring (enum)NoOne 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.

Last updated on