Analytics

Last updated:

Analytics tools include field-level argument descriptions and runnable examples for MCP clients.

Tools Covered

ToolMutationBackend Routes
analytics_fetch_pitchNo/retrieve-pitch-analytics
analytics_chat_groundedNo–

analytics_fetch_pitch

Fetch pitch analytics payload.

Backend routes: /retrieve-pitch-analytics

Arguments

FieldTypeRequiredDescriptionExample
pitch_idstringYesDeal room / playbook pitch identifier.PCH1774126974294428638749
pagenumberNoPagination page number (1-based).1
limitnumberNoMaximum records to return.20
viewer_idstringNoOptional explicit user context override. If omitted, MCP resolves this from the authenticated token/session.IGH6969811447860000000000
organisation_idstringNoOptional explicit organisation context override. If omitted, MCP resolves this from the authenticated token/session.PDX7478889578460000000000

Example Request

Fetch analytics payload for a deal room

{
  "jsonrpc": "2.0",
  "id": "analytics_fetch_pitch-1",
  "method": "tools/call",
  "params": {
    "name": "analytics_fetch_pitch",
    "arguments": {
      "pitch_id": "PCH1774126974294428638749",
      "page": 1,
      "limit": 500
    }
  }
}

Example Success

{
  "success": true,
  "data": {
    "tool": "analytics_fetch_pitch",
    "note": "Payload shape depends on tenant data and backend route output."
  },
  "error": null
}

Example Failure

{
  "success": false,
  "data": null,
  "error": {
    "code": "INVALID_ARGUMENTS",
    "message": "Missing or invalid parameters for analytics_fetch_pitch.",
    "status": 400,
    "retryable": false
  }
}

analytics_chat_grounded

Grounded analytics Q&A with citations.

Backend routes: Derived/indirect handler route.

Arguments

FieldTypeRequiredDescriptionExample
pitch_idstringYesDeal room / playbook pitch identifier.PCH1774126974294428638749
questionstringYesGrounded analytics question asked by assistant.Which buyer persona is most engaged this week and what should I do next?
buyer_emailstringNoOptional buyer email to focus analytics/journey data to one contact.buyer@acme.com
session_idstringNoOptional session identifier for narrowing buyer journey results.SES1774126974294428638749
thread_idstringNoMailbox thread ID.THR1774126974294428638749
email_accountstringNoOptional mailbox account ID to resolve thread in multi-mailbox setups.MBA1774126974294428638749
include_emailsbooleanNoWhen true, include email signal data in journey/analytics context.true
include_meetingsbooleanNoWhen true, include meeting signal data in journey/analytics context.true
analytics_limitnumberNoMax analytics rows fetched for grounded answer context.200
journey_limitnumberNoMax buyer journey rows fetched for grounded answer context.200
search_context_querystringNoOptional scoped semantic query used to narrow context before answering analytics question.security and procurement objections
viewer_idstringNoOptional explicit user context override. If omitted, MCP resolves this from the authenticated token/session.IGH6969811447860000000000
organisation_idstringNoOptional explicit organisation context override. If omitted, MCP resolves this from the authenticated token/session.PDX7478889578460000000000

Example Request

Ask grounded analytics question

{
  "jsonrpc": "2.0",
  "id": "analytics_chat_grounded-1",
  "method": "tools/call",
  "params": {
    "name": "analytics_chat_grounded",
    "arguments": {
      "pitch_id": "PCH1774126974294428638749",
      "question": "What is the best next action based on recent engagement?",
      "include_emails": true,
      "include_meetings": true,
      "analytics_limit": 200,
      "journey_limit": 200
    }
  }
}

Example Success

{
  "success": true,
  "data": {
    "tool": "analytics_chat_grounded",
    "note": "Payload shape depends on tenant data and backend route output."
  },
  "error": null
}

Example Failure

{
  "success": false,
  "data": null,
  "error": {
    "code": "INVALID_ARGUMENTS",
    "message": "Missing or invalid parameters for analytics_chat_grounded.",
    "status": 400,
    "retryable": false
  }
}