Revenue

Cancel Stage Doc Backfill Job

Stop a running backfill, and stop it spending.

IDEMPOTENT: a job that already finished or failed comes back with the status it has, not an error. Credits already spent are not refunded - cancelling stops the next document, it does not undo the last one.

post/revenue/backfills/{job_id}/cancel

Request

  • Base URL: https://be.graph8.com/api/v1
  • URL: https://be.graph8.com/api/v1/revenue/backfills/{job_id}/cancel
  • 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.