List extractions
Use this endpoint to get a filtered list of past extractions.
This endpoint returns a summary for each extraction, listed in reverse chronological order.
To get details about an extraction, use the Retrieve extraction by ID endpoint.
This endpoint uses keyset pagination to retrieve the next page of results.
By default it returns a first page of 20 extractions and an opaque continuation_token that you can pass in the next request to get the next page of results, until the endpoint returns continuation_token to indicate the last page.
Use the limit parameter to configure page size.
Authorizations
Sensible uses API keys to authenticate requests. Keep your API keys secure and do not share them publicly accessible areas such as GitHub, client-side code, etc. Authentication to the API is performed via Bearer Authentication. Provide your API key as the bearer auth value.
Query Parameters
Retrieves extractions with a created date that is equal to or later than this date-time. The default is the unix epoch.
Retrieves extractions with a created date that is equal to or earlier than this date-time. The default is the current date-time.
Use the limit to define the number of items you recieve on each page of the paginated response. The default is 20.
Get the next page of results by making a new request and passing the opaque continuation_token parameter that Sensible returns in the current page of responses. Sensible returns a null continuation_token in the response to indicate the last page.
Comma-delimited list of configurations by which to filter the retrieved extractions.
Comma-delimited list of document types by which to filter the retrieved extractions.
Comma-delimited list of environments (PRODUCTION, DEVELOPMENT) by which to filter the retrieved extractions.
Comma-delimited list of statuses (WAITING, PROCESSING, FAILED, COMPLETE) by which to filter the retrieved extractions.
Minimum extraction coverage score by which to filter the retrieved extractions. For more information about scoring, see Monitoring extractions.
Maximum extraction coverage score by which to filter the retrieved extractions. For more information about scoring, see Monitoring extractions.
Response
DEPRECATED. The continuation_token and limit parameters replace this parameter. DESCRIPTION: Pass the cutoff_date parameter in the next request as the end_date parameter to retrieve the next page of extractions. Note that since Sensible applies the date range filters before all other filters, the cutoff_date can represent the date-time of an extraction that Sensible retrieved using the date range filter, and then removed using other filters.