Skip to content

Analytics

Reference for the 2 CryptoComply MCP tools in the Analytics family.

Tools in this group

analytics_compliance_health

Read-only: yes.

Return the organization's compliance-health report: the checks the platform runs over its own book — profiles missing required answers, screenings overdue, addresses never screened, and the like — each with how many resources it affects. Use for "what needs attention?" rather than "how much is there?", which is analytics_summary.

The report is cached and recomputed periodically; pass refresh to recompute it now, which is slower and rarely what you want mid-conversation.

Returns the report as the API serves it: {generated_at, checks: [...]}, one entry per check with its code, severity and affected count.

Parameters

  • organization_id (Annotated[int, Field(description=ORGANIZATION_ID)], required) — (no description)
  • refresh (Annotated[bool, Field(description='Recompute instead of serving the cached report.')], optional) — (no description)

analytics_summary

Read-only: yes.

Return aggregate counts for an organization: open alerts, profiles by review status, blockchain addresses by risk, and profile screening_hits by resolution. Use for the "what's the state of my book today?" opener.

Optional breakdown_by adds drill-down dimensions; supported values: group (adds profiles grouped by Group), risk (adds profiles grouped by risk rating). Omit for the default shape.

Returns {open_alert_count, profiles_by_review_status, blockchain_addresses_by_risk, profile_screening_hits_by_resolution} plus any requested breakdowns.

Parameters

  • organization_id (Annotated[int, Field(description=ORGANIZATION_ID)], required) — (no description)
  • breakdown_by (Annotated[list[str] | None, Field(description="Optional list of additional drill-down dimensions. Supported: 'group', 'risk'.")], optional) — (no description)