Dashboard

Dashboard Pivot

Per-group volume, share, resolution, containment and handle time.

One RPC call grouped by (dimension, status) answers all five columns. The rates are computed HERE rather than in the browser for a reason that is not tidiness: resolution and containment have different denominators — containment divides by completed+transferred, not by everything — and a client that reconstructs them from bucket counts will eventually pick the obvious denominator and be quietly wrong.

get/core/dashboard/pivot

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

group_bystring

channel | direction | agent | label:<key>, where <key> is a single-valued label key; agents without it group as Unlabelled.

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

keystring required
labelstring required
conversationsinteger required
share_percentnumber nullable
resolved_percentnumber nullable
containment_percentnumber nullable
avg_duration_secondsnumber nullable

Changes

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