---
title: "Estimate All Stage Doc Backfills"
method: POST
path: "/revenue/backfills/estimate"
tags: ["Revenue"]
---

# Estimate All Stage Doc Backfills

`POST /revenue/backfills/estimate`

## Request

- Base URL: `https://be.graph8.com/api/v1`
- URL: `https://be.graph8.com/api/v1/revenue/backfills/estimate`
- Auth: HTTP bearer

What backfilling EVERY stage and both entities would cost. Spends nothing.

The totals plus a per-stage, per-entity breakdown. Published although the
matching "start them all" route is NOT (see the module docstring): seeing
the whole bill in one call is exactly what a caller needs before deciding
which stages to backfill, and this one cannot spend anything.

Declared BEFORE `/backfills/{job_id}` so the literal wins. The two do not
actually collide - one is a POST and the other a GET - but the ordering is
the habit, and the test checks the job route still resolves.

## Headers

- `Authorization` string, nullable
- `X-Target-Org-Id` string, nullable

## Response `200`

Successful Response

- ApiResponseReportPayload
  - `data` ReportPayload, 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.
  - `pagination` PaginationMeta
    - `page` integer, required: Current page number (1-indexed)
    - `limit` integer, required: Items per page
    - `total` integer, required: Total number of items
    - `has_next` boolean, required: Whether there are more pages
    - `next_cursor` string, nullable: Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers.
    - `total_available` integer, nullable: Search endpoints only: how many records really match, when known. Can be larger than `total`, which is capped at the 10,000 results that can be paged. For company search this is a distinct-company estimate. Null when unknown; absent outside search.
    - `total_is_lower_bound` boolean, nullable: Search endpoints only: true when more records match than `total` shows (the result set is larger than the 10,000 results that can be paged). Absent outside search.
    - `notes` string[], nullable: Search endpoints only: plain-language notes about the result, e.g. that more records match than can be paged, or that a reversed `between` range was put in order.

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/graph8/apis/graph8-developer-api.md) · [All operations](https://skmtc.dev/graph8/apis/graph8-developer-api/llms.txt) · [OpenAPI document](https://skmtc.dev/graph8/apis/graph8-developer-api/revisions/2e7cfa0ca921?raw)