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

ParameterTypeDescriptionRequired
workspacestringFilters the response to one workspace. If omitted, returns all accessible workspaces
startDatestringISO 8601 start date. If omitted, uses the start of the billing period
endDatestringISO 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

FieldDescription
idWorkspace ID
nameWorkspace name
usageSummary.billingTypeWorkspace billing type
usageSummary.planWorkspace plan and included credits
usageSummary.rangeEffective date range evaluated
usageSummary.messages.totalMessagesTotal messages used
usageSummary.messages.serviceCountService messages
usageSummary.messages.campaignCountCampaign or template messages
usageSummary.messages.creditsWorkspace included credits
usageSummary.messages.creditsUsedEstimated credits consumed (omitted for enterprise workspaces)
usageSummary.messages.totalChangePctPercentage change vs the previous period
usageSummary.conversations.conversationCountTotal conversations
usageSummary.conversations.assistedConversationCountConversations that required human assistance
usageSummary.conversations.assistanceRequestCountAssistance requests recorded
usageSummary.conversations.autonomyRatePercentage of conversations resolved without human assistance
usageSummary.freshnessLatest update and expected lag per source