Consumption

The consumption API lets you monitor how your workspace uses oHallo. Conversation statistics show volume, resolution rates, and breakdowns by channel and intent. Agent breakdowns show which agents are handling the workload.

Conversation statistics

Retrieve conversation volume and resolution metrics for a workspace.

Required scope: conversations:read

curl "https://api.ohallo.eu/api/workspaces/a1b2c3d4-e5f6-7890-abcd-ef1234567890/consumption/conversation-stats?period=current" \
  -H "Authorization: Bearer sf_live_v1_a3Bx9kLmP2qR7wYz4nDfGhJkQpStUvWx"

Query parameters:

Parameter	Type	Required	Description
period	string	No	Predefined period: current, previous, last_90d (default current)
from	string	No	Start of custom range in ISO 8601 format (overrides period)
to	string	No	End of custom range in ISO 8601 format (overrides period)

The current period covers the current reporting period. The previous period covers the immediately preceding reporting period.

Response:

{
  "total": 482,
  "resolved": 439,
  "byResolution": {
    "ai_resolved": 387,
    "human_resolved": 52,
    "abandoned": 28,
    "open": 15
  },
  "byChannel": {
    "email": 310,
    "chat": 142,
    "whatsapp": 30
  },
  "byIntent": [
    { "intent": "order_status", "count": 156 },
    { "intent": "return_request", "count": 89 },
    { "intent": "product_question", "count": 74 },
    { "intent": "delivery_issue", "count": 62 },
    { "intent": "billing_inquiry", "count": 48 },
    { "intent": "other", "count": 53 }
  ],
  "periodStart": "2026-03-01T00:00:00.000Z",
  "periodEnd": "2026-03-31T23:59:59.999Z"
}

Agent breakdown

Retrieve a breakdown of agent activity for a workspace, split into custom (admin-defined) and system agents.

Required scope: conversations:read

curl "https://api.ohallo.eu/api/workspaces/a1b2c3d4-e5f6-7890-abcd-ef1234567890/consumption/agent-breakdown?period=current" \
  -H "Authorization: Bearer sf_live_v1_a3Bx9kLmP2qR7wYz4nDfGhJkQpStUvWx"

Query parameters:

Parameter	Type	Required	Description
period	string	No	Predefined period: current, previous, last_90d (default current)
from	string	No	Start of custom range in ISO 8601 format (overrides period)
to	string	No	End of custom range in ISO 8601 format (overrides period)

Response:

{
  "custom": [
    { "agentName": "Order Lookup Agent", "count": 312 },
    { "agentName": "Returns Agent", "count": 145 },
    { "agentName": "Meeting Booking Agent", "count": 67 }
  ],
  "system": [
    { "agentName": "Conversation Orchestrator", "count": 482 },
    { "agentName": "Message Composer", "count": 482 },
    { "agentName": "Reply Validator", "count": 478 },
    { "agentName": "Learning Extractor", "count": 439 }
  ],
  "customTotal": 524,
  "systemTotal": 1881,
  "periodStart": "2026-03-01T00:00:00.000Z",
  "periodEnd": "2026-03-31T23:59:59.999Z"
}