Skip to main content
GET
/
usage
Get usage summary
curl --request GET \
  --url https://whatsrb.com/api/v1/usage \
  --header 'Authorization: Bearer <token>'
{
  "data": {
    "plan": "free",
    "sessions": {
      "used": 123,
      "limit": 123
    },
    "daily_business_messages": {
      "used": 123,
      "limit": 123,
      "remaining": 123
    },
    "daily_session_messages": {
      "used": 123,
      "limit": 123,
      "remaining": 123
    },
    "agents": {
      "runs_today": {
        "total": 123,
        "completed": 123,
        "failed": 123,
        "with_actions": 123,
        "empty_actions": 123,
        "conversion_rate": 123
      },
      "pre_filter": {
        "inbound_total": 123,
        "processed": 123,
        "skip_rules": 123,
        "skip_gatekeeper": 123,
        "skip_rate": 123,
        "gatekeeper_calls": 123,
        "gatekeeper_tokens": 123,
        "gatekeeper_errors": 123
      },
      "averages": {
        "avg_tokens": 123,
        "avg_latency_ms": 123,
        "avg_duration_ms": 123
      }
    },
    "send_enabled": true
  }
}

Authorizations

Authorization
string
header
required

API key from the WhatsRB dashboard. Format: Bearer wrb_live_xxx

Response

OK

data
object