Revenue

Get Stage Doc Backfill Job

How a backfill is going: status, progress, credits USED so far, errors.

credits_used is the number that matters while a job runs - it is the spend that has actually happened, against the max_credits ceiling the job was started with.

get/revenue/backfills/{job_id}

Request

  • Base URL: https://be.graph8.com/api/v1
  • URL: https://be.graph8.com/api/v1/revenue/backfills/{job_id}
  • Auth: HTTP bearer

Path parameters

job_idstring required

Backfill job id (UUID).

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

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