Agency

Get Account Health

A health score per client - which accounts need attention.

The report to poll if you only poll one: it is the agency's own churn early-warning, and it is cached for five minutes rather than one.

get/agency/reports/health

Request

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

Query parameters

daysinteger

Trailing window, in days, ending today (UTC).

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.