Skip to main content
POST
Estimate Export

Credits and plans

PAYG is Pay-as-you-go. AYCE is All-you-can-eat. Estimate creates no credit hold or export job. Use Estimate to forecast the cost of a contact export after you have counted the audience and checked a free sample. Send the same filter, row cap, columns, and reveal choices you plan to send to Export.

Choose what to retrieve

Set maxRows to the number of contacts you want. Use reveal to choose which contact details you retrieve; columns controls which fields appear in the file.
  • PAYG exports add 10 credits per SmartSearch filter node, once per request. This means each semantic or lookalike node; ordinary field conditions add no search fee.
  • SmartSearch adds 0 credits on AYCE and is free on Count and View on both plans.
  • Per-request and rate limits apply to both plans, including unlimited AYCE retrieval.
Omitting reveal, or sending null, selects both email and mobile. Removing those fields from columns does not remove their reveal charges. Set reveal explicitly to control the cost.

Example: estimate 100 contacts with email

Set your API key as REVENUEBASE_API_KEY. This reuses the Count/View audience, caps the export at 100 rows, and excludes mobile charges.
Response captured from the local test API on October 13, 2026. Results can change as the dataset or account changes.
AYCE response for the same request:

Estimate, hold, and final charge

The example’s 200-credit estimate covers 100 rows and up to 100 emails. If the exported file has 100 rows and 80 populated emails, the final charge is 180 credits. If the entire matching audience is 100 rows with 80 emails, the estimate and hold use 180 credits.
Your balance must cover the hold, even when the expected final charge is smaller. Export returns 402 INSUFFICIENT_CREDITS if it cannot reserve that amount; it does not automatically export a smaller subset.

Keep the request within a budget

Read your balance with GET /v2/account/balance. Current unit prices are available from the free GET /v2/contact/credits/prices endpoint. Set a positive integer for maxRows and use the estimate to check the reserve for that cap and your reveal choices. Omit maxRows or send null to use the service maximum. Sending 0 returns 422 INVALID_REQUEST.

Errors and next step

A 503 ESTIMATE_UNAVAILABLE means the count used for the forecast timed out. Retry after Retry-After when present or narrow the filter. Export start also needs a successful pricing calculation or a valid confirmed quote. A 422 means the request or filter needs correction. Estimate does not validate every file-format, filename, or requested-column choice; choose fields from the column catalog before starting the export. On a 429, wait for the rate-limit reset. No estimate response starts a paid job. When the choices and budget are right, send the same body to Export. Changing the filter, row cap, or reveal choices requires a new estimate.

Authorizations

X-Key
string
header
required

Body

application/json
filter
GroupNode · object | null

Audience filter, shared with Count and View. Omitted/null selects the entire dataset. Each semantic/lookalike node adds 10 credits on a paid export.

columns
string[] | null

Fields written to the file. Omitted/null uses the default set; ["*"] requests all. Removing email/mobile columns does not remove reveal charges.

format
string
default:json

File format: csv, json (default), or parquet. Does not change unit credit prices.

compression
string
default:gz

gz (default), zip, or none. Does not change unit credit prices.

maxRows
integer | null
Caps exported rows

Positive integer row cap. Omit or send null to use the service maximum of 1,000,000. Sending 0 returns 422 INVALID_REQUEST.

Required range: x >= 1
filename
string | null

Optional base filename: 1–150 letters, digits, spaces, or . _ ( ) -. The API adds the selected file/compression extension.

reveal
string[] | null
Changes credit cost

Buy email (+1 per populated value), mobile (+10), both, or neither ([]), in addition to 1 per contact row. Omitted/null buys both. Columns do not change these charges. Unselected requested fields become availability booleans.

Response

Successful Response

The response is of type Response Estimate Export V1 Exports Estimate Post · object.