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

  • Base URL: https://developer.api.receiptor.ai/v1
  • URL: https://developer.api.receiptor.ai/v1/capabilities/retroactiveExtractions.estimate
  • Auth: one of:
    • API key in header x-receiptor-api-key
    • HTTP bearer

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
}

Changes

No recorded changes to this operation across all 12 revisions of this API.