Vigilfield Docs
API referenceExports

`POST /org-exports/estimates` — estimate the size, cost, and duration of an export before the customer commits to it.

POST/org-exports/estimates

Real estimation requires walking the org's iceberg manifests; until that pipeline lands, the handler reflects the request shape back with zeroed numerics so the UI has a real-typed payload to render against. The breakdown carries per-table rows even when empty so the UI's table picker doesn't need a separate "no estimate yet" path.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Body of POST /org-exports/estimates. The UI sends one of three export shapes: a full data export, a control-plane-only export, or a hybrid "everything" export. control_plane_options selects which control resources to include when the export type isn't pure data.

Response Body

application/json

curl -X POST "https://example.com/org-exports/estimates" \  -H "Content-Type: application/json" \  -d '{}'
{  "breakdown": {    "control_plane_bytes": 0,    "data_bytes": 0,    "table_breakdown": [      {        "bytes": 0,        "table_id": "string",        "table_name": "string"      }    ]  },  "cost_usd": 0.1,  "estimated_bytes": 0,  "estimated_duration_seconds": 0,  "estimated_rows": 0,  "size_bytes": 0}