Analytics

Get one section of the CRM performance overview

crm.analytics.summary

Returns one section of the CRM performance overview for a date range (start/end in epoch ms): kpis (open pipeline value and count, won revenue and count, lost and created counts, win rate, average deal value and cycle, rotting deals, and what became of the deals created in the range; every amount in one currency, each deal converted with the rate of its close date, with the sums per original currency next to it), velocity (average days the open deals have sat in each stage), funnel (cohort conversion of the deals created in the range through the stages, optionally broken down by outcome, owner or source), activity (calls, emails, meetings, tasks, notes, WhatsApp and other per UTC day) or leaderboard (won revenue in one currency, deals won and activities per owner, with the name the CRM team shows). velocity and funnel need a pipeline_id; a pipeline_id that does not exist answers pipeline_not_found in every section. The funnel breakdown comes as segments (label → count) and segment_list (with the owner's user id). The filters mirror the Performance toolbar (owners, labels, stages, value range, creation dates, activity types, deals that entered a stage). Members without view_all_performance only get their own numbers. Heavy read: a section scans up to 30,000 deals or activities per dataset; truncated: true means partial numbers. crm.pipelines.stage_counts is not a cheap substitute: it counts every deal that points at a stage whatever its state (won, lost, archived, merged away), so for live numbers use kpis or funnel here.

Scope

crm:read

Permission

View the module · CRM action: view_performance

MCP tool

crm_analytics_summaryOn the full surface; on the compact one, mb_execute_operation with id: "crm.analytics.summary".

Declared cost: up to 120004 reads and 0 writes per call (they count against the daily quota).

Parameters

Response

A JSON object in snake_case.

Errors

Example

curl "https://api.mb-suite.com/v1/crm/analytics/summary?start=0&end=0" \
  -H "Authorization: Bearer $MB_API_KEY"

Try it with your test API key

With a test API key the request always goes to your practice organization: example data you can reset.

curl "https://api.mb-suite.com/v1/crm/analytics/summary?start=0&end=0" \
  -H "Authorization: Bearer $MB_TEST_KEY"

Run a CRM report (group by dimensions, compute metrics)

crm.analytics.pivot

Runs the CRM report engine behind CRM reports, the Explorer and the dashboard widgets: groups deals, activities, outbound human WhatsApp messages and prospects (leads) of a date range by up to 4 dimensions (date, month, pipeline, stage, owner, source, lead_source, country, status, activity_type, label, product_line, attr.<attribution field> such as attr.campaignName, custom.<custom field slug>) and computes up to 10 metrics (deals_count, open_count, won_count, lost_count, total_value, won_value, weighted_value, avg_value, min_value, max_value, mrr_total, quotes_count, win_rate, avg_cycle_days, activities_count, activities_completed_count, calls_count, calls_completed_count, meetings_count, emails_sent_count, notes_count, tasks_completed_count, whatsapp_sent_count, calls_unique_count, whatsapp_unique_count, deals_activity_done_14d/30d, deals_no_activity_14d/30d, leads_count, leads_attributed). Money metrics come in currency (the organization's reporting currency: each deal converted before aggregating). Optional filters (field, operator, value), a column_dimension for a cross-tab (its cells are keyed c<index>.<metric>, the index of pivot_columns) and date_field (created_at, won_at, lost_at, closed_at or stage_moved_at) for metrics without their own date anchor. Row values are what the table shows: status as Abierto, Ganado or Perdido, and the names of pipelines, stages, owners and lead sources (label gives the label id); dimension_value_ids maps each of them to its id or code. A filter on owner, stage, pipeline or lead_source takes the id or the name; on status and source, the code or the label. Ad-spend metrics (ad_spend, cpl, cac, cost_per_deal, roas_crm…) are not available here. Members without view_all_performance only count their own records. Heavy read (up to 30,000 docs per dataset); at most 1,000 rows (sorted by the first metric, except in a cross-tab), with rows_total and rows_truncated. Use crm.attribution.facets first to know which attr.* values exist. With Google Ads, LinkedIn or TikTok, their terms limit it through the API and the MCP: what they do not allow answers 403 platform_terms_restricted (the permissions guide lists what each platform allows).

Scope

crm:read

Permission

View the module · CRM action: view_performance

MCP tool

crm_analytics_pivotOn the full surface; on the compact one, mb_execute_operation with id: "crm.analytics.pivot".

Declared cost: up to 150503 reads and 0 writes per call (they count against the daily quota).

Parameters

Response

Errors

Example

curl -X POST "https://api.mb-suite.com/v1/crm/analytics/pivot" \
  -H "Authorization: Bearer $MB_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
  "start": 0,
  "end": 0,
  "metrics": [
    "METRIC"
  ]
}'

Try it with your test API key

With a test API key the request always goes to your practice organization: example data you can reset.

curl -X POST "https://api.mb-suite.com/v1/crm/analytics/pivot" \
  -H "Authorization: Bearer $MB_TEST_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
  "start": 0,
  "end": 0,
  "metrics": [
    "METRIC"
  ]
}'