Analytics

The Overview dashboard: sends, replies, bounces and sentiment. 1 endpoint, each also a tool for your AI through MCP. Authentication and errors are on the overview.

Workspace dashboard: sends, replies, positive replies, bounces, won, mailbox health and when and where replies come from

GET/api/v1/analytics/overview

Counts for the last 7, 30 or 90 days plus the period before for trends. Positive replies and sentiment use the label each reply thread carries now.

MCP tool get_overviewRead-only

Parameters

daysquery · number: 7, 30 or 90 days

Returns

daysrequirednumber
timezonerequiredstring: Workspace timezone: days in the series are calendar days here
seriesrequiredobject[]
totalsrequiredobject
previousrequiredobject: The same counts for the period just before, for trends
tracksOpensrequiredboolean
mailboxesrequiredobject
sentimentrequiredobject
heatmaprequirednumber[][]: Replies by weekday (Monday first) and hour, in each lead's time zone
countriesrequiredobject[]
repliesWithoutCountryrequirednumber
sendingrequiredboolean: Something has ever been sent from this workspace

cURL

curl https://ballast.to/api/v1/analytics/overview \
  -H "Authorization: Bearer $BALLAST_API_KEY"

API reference