Extractions

Get the extracted rows as JSON

The rows of a completed extraction, in pages, each row an object keyed by the output columns exactly as the JSON output file holds it: native JSON types when the extraction was submitted with options.json_typed_values, strings otherwise. The Source File and Review Needed columns are present unless excluded at submission. The Review Needed items whose rows fall on the page come back alongside; review_needed.count is the count for the whole extraction. Rows are available for the same 90 days as the output files.

Rate limit: 60 requests per minute per API key.

get/extractions/{extraction_id}/results

Request

  • Base URL: https://api.invoicedataextraction.com/v1
  • URL: https://api.invoicedataextraction.com/v1/extractions/{extraction_id}/results
  • Auth: HTTP bearer

Path parameters

extraction_idstring uuid required

The extraction_id returned by submitExtraction.

Query parameters

offsetinteger

Rows to skip.

limitinteger

Rows per page.

scope'own' | 'team'

own or team. Team admins default to team and see every team member's extractions; everyone else defaults to own, and a non-admin passing team gets 403 FORBIDDEN. Under team, items carry submitted_by.

Response

One page of rows.

successtrue required
extraction_idstring uuid required
status'completed' required
output_structure'per_invoice' | 'per_line_item' required
output_expires_atstring date-time required
json_typed_valuesboolean required

true when values carry native JSON types; false when every value is a string.

columnsstring[] required

The output column names in order.

rowsobject[] required

One object per row with a value under every column. Row i of the page (from 0) is data row offset + i + 1.

offsetinteger required
limitinteger required
row_countinteger required
total_rowsinteger required
has_moreboolean required
next_offsetinteger nullable required

Changes

No recorded changes to this operation across all 1 revision of this API.