Skip to main content
POST
Estimate what an upload will cost against a Domain's budget

Authorizations

X-API-Key
string
header
required

Path Parameters

tenancy_id
string
required

Body

application/json

Ask what an upload would cost, without committing to it.

Give exactly ONE row source — either record_set_id for rows already uploaded, or record_count for a hypothetical size — and at least one of bucket or action_id so the estimate knows which provider budget to price against. Supplying both row sources, or neither, is rejected: two sources could disagree and there would be no principled way to choose between them.

bucket
string | null
action_id
string | null
record_set_id
string | null
record_count
integer | null
Required range: 1 <= x <= 50000000

Response

Successful Response

What an upload will cost against the Domain's provider budget.

A spill warning is INFORMATIONAL and never refuses a trigger. Uploading more than a day's remaining budget is a supported way to use the platform: the dispatcher paces the overflow into the following day and keeps going. Use this to tell someone what an upload will consume before they commit to it — and if they change their mind after triggering, cancel the batch rather than expecting this estimate to have blocked it.

calls is how many provider calls records rows cost at max_records_per_call; pct_of_remaining_day is THIS upload's own share of what is left today, while spills_past_day_cap also counts the work already queued ahead of it — so a modest upload can read as a small percentage and still be flagged as spilling because of the backlog in front of it. day_remaining_calls, pct_of_remaining_day and spills_past_day_cap are null when the remaining daily budget cannot be read, because a percentage of an unknown budget is unknown rather than zero.

bucket
string
required
records
integer
required
calls
integer
required
max_records_per_call
integer
required
day_remaining_calls
integer | null
pct_of_remaining_day
number | null
queued_estimated_calls
integer
default:0
spills_past_day_cap
boolean | null
warning
string | null
as_of
string<date-time> | null