Usage

Get Organization Usage

Changed on

This organization's credit usage over the last 7, 30 or 90 days, with the previous period for comparison.

range, totals (credits used, operations, active days, busiest day), previous (with change_pct, null when the previous period recorded nothing), a daily series, and a breakdown by service. has_credit_account is false when the organization has no credit account yet, which is not the same as "no activity". 504 when the aggregation is slow (retry), 500 when it fails.

get/usage/organization

Request

  • Base URL: https://be.graph8.com/api/v1
  • URL: https://be.graph8.com/api/v1/usage/organization
  • Auth: HTTP bearer

Query parameters

daysinteger

Window length: 7, 30 or 90 days. Anything else is a 400.

Headers

Authorizationstring nullable
X-Target-Org-Idstring 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