Usage Summary
Returns the main monitoring summary for the workspace: message consumption, credits used, conversations, and autonomy rate.
GET https://api.platica.mx/v1/usage/summary Query parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
workspace | string | Filters the response to one workspace. If omitted, returns all accessible workspaces | — |
startDate | string | ISO 8601 start date. If omitted, uses the start of the billing period | — |
endDate | string | ISO 8601 end date. If omitted, uses the end of the billing period | — |
Response
{
"workspaces": [
{
"id": "g6yCA16pkWl5eXo7KszB",
"name": "My company",
"usageSummary": {
"billingType": "subscription",
"plan": {
"name": "Growth",
"credits": 6500
},
"billingPeriod": {
"startDate": "2026-06-01T00:00:00.000Z",
"endDate": "2026-06-30T23:59:59.999Z"
},
"range": {
"startDate": "2026-06-01T00:00:00.000Z",
"endDate": "2026-06-30T23:59:59.999Z"
},
"dataSince": "2026-05-21T06:00:00.000Z",
"messages": {
"totalMessages": 1200,
"serviceCount": 950,
"campaignCount": 250,
"creditsUsed": 1320,
"credits": 6500,
"totalChangePct": -8.8,
"serviceChangePct": -11.2,
"campaignChangePct": 0
},
"conversations": {
"conversationCount": 340,
"assistedConversationCount": 28,
"assistanceRequestCount": 35,
"autonomyRate": 91.76
},
"freshness": {
"usage": {
"source": "daily_aggregations",
"lastUpdated": "2026-06-29T18:31:10.000Z",
"expectedLagSeconds": 30
},
"conversations": {
"source": "daily_aggregations",
"lastUpdated": "2026-06-29T18:00:05.000Z",
"expectedLagMinutes": 60
}
}
}
}
],
"workspacesCount": 1
} Response fields
| Field | Description |
|---|---|
id | Workspace ID |
name | Workspace name |
usageSummary.billingType | Workspace billing type |
usageSummary.plan | Workspace plan and included credits |
usageSummary.range | Effective date range evaluated |
usageSummary.messages.totalMessages | Total messages used |
usageSummary.messages.serviceCount | Service messages |
usageSummary.messages.campaignCount | Campaign or template messages |
usageSummary.messages.credits | Workspace included credits |
usageSummary.messages.creditsUsed | Estimated credits consumed (omitted for enterprise workspaces) |
usageSummary.messages.totalChangePct | Percentage change vs the previous period |
usageSummary.conversations.conversationCount | Total conversations |
usageSummary.conversations.assistedConversationCount | Conversations that required human assistance |
usageSummary.conversations.assistanceRequestCount | Assistance requests recorded |
usageSummary.conversations.autonomyRate | Percentage of conversations resolved without human assistance |
usageSummary.freshness | Latest update and expected lag per source |
Nota
For enterprise workspaces, messages includes credits (the workspace allotment) but not creditsUsed, because enterprise billing uses customer-specific rates.
Consejo
For daily or dimensional breakdowns, use Message Usage or Conversation Usage .