ANanyreach
Dashboard

Agent Health

Per-agent volume, completion, containment and AHT for the window.

A sibling of GET /core/agents rather than an include=health parameter on it: the roster and its health have different cache lifetimes (the roster changes when someone edits an agent, the health numbers change constantly), and keeping them separate lets the client refetch one without the other.

get/core/dashboard/agent-health

Request

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

Query parameters

agent_idsstring nullable

Comma-separated agent ids. Omit for every agent.

labelsstring nullable

JSON label filter, as on GET /core/agents: only agents whose labels match, e.g. {"industry": ["Telecom"]}.

agent_idstring nullable
created_afterstring date-time nullable
created_beforestring date-time nullable
periodstring 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.

channelstring nullable
directionstring nullable
timezonestring nullable

IANA zone, e.g. America/New_York. Day buckets and named periods follow it. UTC if omitted.

exclude_durationstring 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_turnsstring nullable

Leave out conversations by caller turns, as exclude_duration (e.g. lte:0). Never removes one without a turn count (email, text).

exclude_callersstring nullable

Comma-separated caller numbers in international format to leave out; matches telephone conversations only.

keep_transferredboolean

False applies exclude_duration and exclude_turns to transferred conversations too. By default a transferred call is always counted, however short.

Headers

x-anyreach-orgstring nullable

Organization ID for user PATs (pat_ prefix tokens)

Response

Successful Response

agent_idstring required
agent_namestring nullable
conversationsinteger required
completedinteger required
transferredinteger required
engagedinteger required
completion_ratenumber nullable
containment_ratenumber nullable
aht_secondsnumber nullable
last_conversation_atstring date-time nullable
health_scorenumber nullable
health_score_formulastring
health_statusstring required

Changes

No recorded changes to this operation across all 1 revision of this API.