Skip to main content
GET
/
api
/
escalation-dashboard
/
availability-timeline
Get bucketed per-agent and aggregate availability timeline
curl --request GET \
  --url https://your-instance.example.com/api/escalation-dashboard/availability-timeline \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "data": {
    "start": "2026-05-18T00:00:00.000Z",
    "end": "2026-05-18T15:00:00.000Z",
    "bucketMinutes": 15,
    "buckets": [
      "2026-05-18T14:30:00.000Z"
    ],
    "agents": {
      "5f7b1c2e8a1d4e0012c3b4a5": [
        "available"
      ]
    },
    "aggregate": [],
    "users": []
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.tetherai.ca/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
departmentId
string

Optional department filter. ADMIN/SUPERADMIN may pass any departmentId; DEPARTMENT_HEAD is implicitly scoped to their own department and any other value is ignored.

​
start
string<date-time>

ISO-8601 start of the window. Defaults to end - 24h.

​
end
string<date-time>

ISO-8601 end of the window. Defaults to now.

​
bucketMinutes
integer
default:15

Bucket size in minutes. Clamped to [1, 120].

Required range: 1 <= x <= 120

Response

Availability timeline returned

​
success
enum<boolean>
required
Available options:
true
​
data
object
required
Example:
{
  "start": "2026-05-18T00:00:00.000Z",
  "end": "2026-05-18T15:00:00.000Z",
  "bucketMinutes": 15,
  "buckets": [
    "2026-05-18T14:30:00.000Z",
    "2026-05-18T14:45:00.000Z"
  ],
  "agents": {
    "5f7b1c2e8a1d4e0012c3b4a5": ["available", "at_capacity"]
  },
  "aggregate": [
    {
      "state": "available",
      "onlineUserIds": ["5f7b1c2e8a1d4e0012c3b4a5"],
      "availableUserIds": ["5f7b1c2e8a1d4e0012c3b4a5"],
      "atCapacityUserIds": [],
      "userDurations": []
    }
  ],
  "users": [
    {
      "_id": "5f7b1c2e8a1d4e0012c3b4a5",
      "fullName": "Sam Patel",
      "email": "sam.patel@acme.example"
    }
  ]
}