Sign in

v3

latestOpenAPI 3.0.02026-07-31800117.7 KB
Capabilities

retroactiveExtractions.estimate

Queue a Retroactive Scan estimate for the given email integration and date range. Returns a jobId immediately; poll with getRetroactiveExtractionEstimate. Estimation against a real mailbox can take minutes; use the poll capability rather than waiting.

post/capabilities/retroactiveExtractions.estimate

Request body

integrationIdstring required

The email integration ID to estimate against (use listIntegrations to find).

fromDatestring required

Inclusive start date in YYYY-MM-DD format.

toDatestring required

Inclusive end date in YYYY-MM-DD format.

sendersPreference'allowed' | 'blocked' required

Whether the sender list is an allow-list or block-list.

mailboxIdstring

Mailbox/folder id to scope the estimate. Defaults to 'all'.

Response

Successful response

successboolean
codeinteger

Example response

{
  "success": true,
  "code": 200
}