---
title: "Get Dashboard"
method: GET
path: "/core/dashboard"
tags: ["Dashboard"]
---

# Get Dashboard

`GET /core/dashboard`

## Request

- Base URL: `https://api.anyreach.ai` (the document declares no server; this is the origin it was published from)
- URL: `https://api.anyreach.ai/core/dashboard`
- Auth: HTTP bearer

## Query parameters

- `compare_to` string: previous_period (default) or none.
- `agent_id` string, nullable
- `created_after` string, date-time, nullable
- `created_before` string, date-time, nullable
- `period` string, nullable: Named window: today, mtd, qtd, ytd, or a count like 24h / 7d / 30d / 90d. Ignored when created_after is given. Defaults to 30 days.
- `channel` string, nullable
- `direction` string, nullable
- `timezone` string, nullable: IANA zone, e.g. America/New_York. Day buckets and named periods follow it. UTC if omitted.
- `exclude_duration` string, nullable: Leave out conversations by duration in seconds: comma-separated op:value rules, op lte or gte (e.g. lte:10,gte:3600). Never removes one without a duration, nor a transferred one unless keep_transferred is false.
- `exclude_turns` string, nullable: Leave out conversations by caller turns, as exclude_duration (e.g. lte:0). Never removes one without a turn count (email, text).
- `exclude_callers` string, nullable: Comma-separated caller numbers in international format to leave out; matches telephone conversations only.
- `keep_transferred` boolean: False applies exclude_duration and exclude_turns to transferred conversations too. By default a transferred call is always counted, however short.

## Headers

- `x-anyreach-org` string, nullable: Organization ID for user PATs (pat_ prefix tokens)

## Response `200`

Successful Response

- DashboardResponse
  - `total_agents` integer, required
  - `live_agents` integer, required
  - `total_conversations` integer, required
  - `agent_call_volume` AgentVolumeItem[], required
    - `agent_id` string, required
    - `agent_name` string, required
    - `call_count` integer, required
  - `call_volume_trend_30d` TrendPoint[], required
    - `date` string, required
    - `count` integer, required
  - `direction_distribution` PercentageBreakdown, required
    - `inbound_percent` number, nullable
    - `outbound_percent` number, nullable
  - `status_distribution` StatusBreakdown, required
    - `completed_percent` number, nullable
    - `transferred_percent` number, nullable
  - `window` DashboardWindow: The window actually used, echoed back because `period` is resolved server-side and the client needs to label the chart with the real dates.
    - `created_after` string, date-time, required
    - `created_before` string, date-time, required
  - `live_conversations` integer, nullable
  - `containment_percent` number, nullable
  - `avg_duration_seconds` number, nullable
  - `status_counts` StatusCount[]
    - `status` string, required
    - `count` integer, required
    - `percent` number, required
  - `channel_counts` ChannelCount[]
    - `channel` string, required
    - `count` integer, required
    - `percent` number, required
  - `previous` DashboardComparison: Headline numbers for the comparison window.
    - `window` DashboardWindow, required: The window actually used, echoed back because `period` is resolved server-side and the client needs to label the chart with the real dates.
      - `created_after` string, date-time, required
      - `created_before` string, date-time, required
    - `total_conversations` integer, required
    - `completed_percent` number, nullable
    - `transferred_percent` number, nullable
    - `containment_percent` number, nullable
    - `avg_duration_seconds` number, nullable
  - `deltas` DashboardDeltas: Current minus previous. Volume is a RELATIVE change (percent of the previous count); the rates are absolute PERCENTAGE-POINT moves, because the percent change of a percentage is what makes "completion fell 5%" ambiguous. The field names carry the distinction so a caller cannot mix them up.
    - `avg_duration_seconds_delta` number, nullable
    - `total_conversations_percent` number, nullable
    - `completed_percent_points` number, nullable
    - `transferred_percent_points` number, nullable
    - `containment_percent_points` number, nullable
  - `excluded_conversations` integer, nullable

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/anyreach/apis/anyreach-api.md) - [All operations](https://skmtc.dev/anyreach/apis/anyreach-api/llms.txt) - [OpenAPI document](https://skmtc.dev/anyreach/apis/anyreach-api/revisions/2eddf40c8c93?raw)