Skip to content

team.home

The numbers Home shows: calls, answers, outcomes, what needs attention.

Reference

GET/api/v1/team/home

Auth
API key in X-API-Key
Content
none
Returns
200 · HomeResponse

Everything above the fold on the home screen, in one request. The charts below the fold are deliberately not here. They are the expensive queries and nobody should pay for them before scrolling.

Arguments

ArgumentInTypeRequiredDescription
hoursqueryintegerdefault 24

Example request

curl -X GET "https://api.decibyl.ai/api/v1/team/home" \
  -H "X-API-Key: dcb_your_key"

Response

{
  "hours": 1,
  "span": "today",
  "headline": {
    "agents": 1,
    "live": 1,
    "calls": 1,
    "answered": 1,
    "outcomes": 1,
    "needs_attention": 1
  },
  "suggestions": [
    {
      "kind": "string",
      "text": "string",
      "action": "string",
      "prompt": "string",
      "href": "string"
    }
  ],
  "openers": [
    {
      "kind": "string",
      "text": "string",
      "helper": "string",
      "helper_name": "string",
      "template": "string"
    }
  ],
  "members": [
    {
      "workflow_id": 1,
      "workflow_uuid": "string",
      "name": "string",
      "is_live": true,
      "status": "string",
      "tone": "string",
      "at": "2026-09-14T09:30:00Z",
      "calls": 1,
      "answered": 1,
      "outcomes": 1,
      "failures": 1,
      "last_action": {
        "label": "string",
        "app": "string",
        "status": "string",
        "at": "2026-09-14T09:30:00Z"
      },
      "last_line": "string",
      "last_at": "2026-09-14T09:30:00Z",
      "last_actor": "string",
      "avatar": {
        "shape": "cercle",
        "color": "encre",
        "expression": "neutre"
      }
    }
  ]
}

Errors

StatusWhen
404Not found
422Validation Error