GET/v1/reports/summarystable

Workspace summary

Needs: Read your data (mcp:read)
Plan: Any plan with API access
Limits: 300 a minute per key
Undo: Nothing to undo: this only reads.

One call for the headline numbers of a period: messages, conversations, new contacts, broadcasts and SLA breaches.

A metric this workspace cannot answer is null and listed in unavailable[] with the reason. Never read `null` as zero.

Try it

Query (4)

presetoptionalstring

A named period. Default `last_7_days`. Weeks start on Monday.

fromoptionalstring

First day, YYYY-MM-DD. Give `from` and `to` together; they override `preset`. Up to 186 days.

tooptionalstring

Last day (inclusive), YYYY-MM-DD.

timezoneoptionalstring

IANA time zone, e.g. `Asia/Dubai`. Default: your workspace time zone.

This only reads. It uses your real data and changes nothing.

curl -X GET 'https://mcp.wa-api.cloud/v1/reports/summary?preset=last_7_days' \
  -H "Authorization: Bearer $API_KEY"

The code reads your key from $API_KEY.

Parameters

Parameters
Field	Type	What it is
preset	string · query	A named period. Default `last_7_days`. Weeks start on Monday.one of: `today`, `yesterday`, `last_7_days`, `last_14_days`, `last_30_days`, `this_month`, `last_month`, `this_week`, `last_week`
from	string · query	First day, YYYY-MM-DD. Give `from` and `to` together; they override `preset`. Up to 186 days.pattern `^\d{4}-\d{2}-\d{2}$`
to	string · query	Last day (inclusive), YYYY-MM-DD.pattern `^\d{4}-\d{2}-\d{2}$`
timezone	string · query	IANA time zone, e.g. `Asia/Dubai`. Default: your workspace time zone.1–64 characters

Headers

Headers
Field	Type	What it is
Authorizationrequired	header	`Bearer $API_KEY` — your API key.
Api-Version	header	The API version to use, e.g. `2026-10-01`. Default: the version your key is pinned to.one of: `2026-10-01` · pattern `^\d{4}-\d{2}-\d{2}$`

Response `200`

The summary.

Response fields
Field	Type	What it is
rangerequired	object	The range and timezone these numbers were counted in — always state it when reporting them.
fromrequired	string	First local day (YYYY-MM-DD), inclusive.
torequired	string	Last local day (YYYY-MM-DD), inclusive.
daysrequired	integer	Number of local days in the range.-9007199254740991–9007199254740991
timezonerequired	string	IANA timezone the days were counted in.
started_atrequired	string	Range start as a UTC instant (ISO-8601).
ended_atrequired	string	Range end as a UTC instant (ISO-8601), exclusive.
presetrequired	string or null	The named range used, if any.
workspacerequired	object
company_idrequired	string or null
namerequired	string or null
timezonerequired	string or null	The workspace timezone the platform holds; the range above says which timezone was actually used.
contacts_totalrequired	integer or null	All contacts ever (not the range).-9007199254740991–9007199254740991
messagesrequired	object
sentrequired	integer or null	-9007199254740991–9007199254740991
deliveredrequired	integer or null	-9007199254740991–9007199254740991
readrequired	integer or null	-9007199254740991–9007199254740991
failedrequired	integer or null	-9007199254740991–9007199254740991
delivery_raterequired	number or null
conversationsrequired	object
closesrequired	integer or null	Conversations closed in the range (closing events).-9007199254740991–9007199254740991
distinct_conversationsrequired	integer or null	-9007199254740991–9007199254740991
reopenedrequired	integer or null	-9007199254740991–9007199254740991
median_close_secondsrequired	number or null
waiting_nowrequired	integer or null	Waiting on us right now (live, not part of the range).-9007199254740991–9007199254740991
unassigned_nowrequired	integer or null	-9007199254740991–9007199254740991
oldest_wait_buckets_nowrequired	object or null
contactsrequired	object
newrequired	integer or null	Contacts created in the range.-9007199254740991–9007199254740991
new_is_lower_boundrequired	boolean	true = the platform has no count-by-date, the walk was cut short, and "new" is a minimum.
broadcastsrequired	object
startedrequired	integer or null	-9007199254740991–9007199254740991
sentrequired	integer or null	-9007199254740991–9007199254740991
deliveredrequired	integer or null	-9007199254740991–9007199254740991
readrequired	integer or null	-9007199254740991–9007199254740991
failedrequired	integer or null	-9007199254740991–9007199254740991
opted_outrequired	integer or null	-9007199254740991–9007199254740991
slarequired	object
runningrequired	boolean or null	Is SLA active for this workspace (plan AND module switch)?
breachesrequired	integer or null	-9007199254740991–9007199254740991
config_problemsrequired	integer or null	-9007199254740991–9007199254740991
agentsrequired	object
sessionsrequired	integer or null	AI-agent conversations started in the range (studio tests excluded).-9007199254740991–9007199254740991
handoffsrequired	integer or null	Of those, handed over to a human.-9007199254740991–9007199254740991
resolution_raterequired	number or null
chatbotsrequired	object
sessionsrequired	null	Always null: The platform keeps no chatbot usage analytics.
notesrequired	array of string
unavailablerequired	array of object	Metrics that are UNKNOWN (missing data source), not zero. Say so when reporting; do not fill them in with 0.
metricrequired	string	Which metric or section is missing, e.g. "messages.read".
reasonrequired	string	Why it is missing (not supported by this server version, service not configured, forbidden, temporarily unavailable…).

Errors

Errors are application/problem+json. Branch on code.

Status	Code	When
400	invalid_input	A field is missing or has the wrong format. `errors[]` points at each field. The range is reversed, in the future, longer than 186 days, or the time zone is unknown.
401	unauthenticated	The Authorization header is missing, the key is unknown, expired or revoked.
403	entitlement_required	The workspace's plan does not include API access (`api_access`).
403	insufficient_scope	The key does not have the permission this operation needs.
429	rate_limited	The key or workspace went over its rate limit. Wait for `Retry-After` seconds.
503	upstream_unavailable	A service behind the API is briefly unavailable. Safe to retry with backoff.

Examples

Last 7 days

Response 200

{
  "range": {
    "from": "2026-09-17",
    "to": "2026-09-23",
    "days": 7,
    "timezone": "Asia/Dubai",
    "started_at": "2026-09-16T20:00:00Z",
    "ended_at": "2026-09-23T20:00:00Z",
    "preset": "last_7_days"
  },
  "messages": {
    "sent": 1840,
    "delivered": 1791,
    "read": 1422,
    "failed": 12,
    "delivery_rate": 0.973
  },
  "conversations": {
    "closes": 406,
    "reopened": 31,
    "median_close_seconds": 5400,
    "waiting_now": 9,
    "unassigned_now": 4,
    "distinct_conversations": null,
    "oldest_wait_buckets_now": null
  },
  "contacts": {
    "new": 233,
    "new_is_lower_bound": false
  },
  "broadcasts": {
    "started": 3,
    "sent": 5210,
    "delivered": 5096,
    "failed": 44,
    "read": null,
    "opted_out": null
  },
  "sla": {
    "breaches": 7,
    "running": null,
    "config_problems": null
  },
  "notes": [],
  "unavailable": [],
  "workspace": {
    "company_id": null,
    "name": null,
    "timezone": null,
    "contacts_total": null
  },
  "agents": {
    "sessions": null,
    "handoffs": null,
    "resolution_rate": null
  },
  "chatbots": {
    "sessions": null
  }
}

Operation path

The same operation is also at POST /v1/ops/reports_workspace_summary, with every field in the JSON body.