Analytics

Get credit usage

Returns credit use for the current billing period: the period's start and end, total credits_used, the AI and AI insights credits within it, and call minutes by call type (inbound, outbound, web). Use it to track spend or to bill your own customers.

GET

https://api.nabrah.ai/api/ext/insights/usage

Get credit usage

curl --request GET \
  --url 'https://api.nabrah.ai/api/ext/insights/usage?tz=<tz>' \
  --header 'X-API-Key: <your-api-key>'

{
  "period_start": "2026-01-15T12:00:00.000Z",
  "period_end": "2026-01-15T12:00:00.000Z",
  "credits_used": 0,
  "ai_credits": 0,
  "ai_insights_credits": 0,
  "minutes": {
    "inbound": 0,
    "outbound": 0,
    "web": 0,
    "total": 0
  },
  "unavailable": [
    "string"
  ]
}

Good to know

Whole workspace

Usage covers the whole workspace tied to your API key, not one agent. For per-agent numbers, use POST /api/ext/insights/agents.

unavailable

Lists the parts that could not be loaded this time ("usage" or "minutes"); retry later for them. Results are cached for up to an hour.

Authorization

X-API-Keystringheaderrequired

Your workspace API key. Create one in the dashboard under API keys.

Query parameters

tzstringrequired

Your IANA time zone, e.g. Asia/Riyadh. The period is counted up to the start of today in this zone.

Response

200

Successful Response

application/json

422

Validation Error

application/json