Agency

Get Agency Dialer Dashboard

Dialer KPIs aggregated over every client.

get/agency/reports/dialer/dashboard

Request

  • Base URL: https://be.graph8.com/api/v1
  • URL: https://be.graph8.com/api/v1/agency/reports/dialer/dashboard
  • Auth: HTTP bearer

Query parameters

start_datestring required

Start date, YYYY-MM-DD.

end_datestring required

End date, YYYY-MM-DD.

org_filterstring nullable

Narrow to ONE client org. Silently ignored when it names an org outside this agency's authorized set - it can select within the set, never widen it.

Headers

X-Target-Org-Idstring nullable
Authorizationstring nullable

Response

Successful Response

dataReportPayload required

An OPEN envelope around one report's answer.

The app wraps every one of these reports in {success, data, meta}, where meta carries the cache state, the window and - on the agency reports - failed_org_ids, the orgs that contributed NOTHING to the totals above. That field is the difference between "this client sent no email" and "we could not query this client", so it is forwarded rather than flattened away.

Open on purpose: data is dict | list in the app and its contents grow with the product. A closed model would turn every new metric into a silently dropped one.

Changes

No recorded changes to this operation across all 2 revisions of this API.