Retrieve Extractions

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.

GET

extractions

curl --request GET \
  --url https://api.sensible.so/v0/extractions \
  --header 'Authorization: Bearer <token>'

{
  "extractions": [
    {
      "id": "246a6f60-0e5b-11eb-b720-295a6fba723e",
      "created": "2022-10-31T16:27:53.433Z",
      "completed": "2022-10-31T16:27:53.741Z",
      "status": "COMPLETE",
      "validation_summary": {
        "fields": 6,
        "fields_present": 4,
        "errors": 0,
        "warnings": 1,
        "skipped": 1
      },
      "page_count": 100,
      "document_name": "example.pdf",
      "environment": "DEVELOPMENT",
      "coverage": 0.75,
      "type": "auto_insurance_quotes_all_carriers",
      "configuration": "config_for_x_company",
      "errors": [
        {
          "field_id": "phone_number",
          "message": "ConfigurationError: width <=0",
          "type": "configuration"
        }
      ],
      "validations": [
        {
          "description": "Policy number must be 11 digits",
          "severity": "error"
        },
        {
          "description": "Company email must be in format string@string",
          "severity": "skipped",
          "message": "Missing prerequisites - company_email"
        }
      ]
    }
  ],
  "cutoff_date": null
}

Authorizations

Authorization

string

header

required

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

start_date

string

default:

1970-01-01T00:00:00.000Z

Retrieves extractions with a created date that is equal to or later than this date-time. The default is the unix epoch.

end_date

string

Retrieves extractions with a created date that is equal to or earlier than this date-time. The default is the current date-time.

limit

number

default:

Use the limit to define the number of items you recieve on each page of the paginated response. The default is 20.

continuation_token

string

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.

configuration_ids

string

Comma-delimited list of configurations by which to filter the retrieved extractions.

document_type_ids

string

Comma-delimited list of document types by which to filter the retrieved extractions.

environments

string

Comma-delimited list of environments (PRODUCTION, DEVELOPMENT) by which to filter the retrieved extractions.

statuses

string

Comma-delimited list of statuses (WAITING, PROCESSING, FAILED, COMPLETE) by which to filter the retrieved extractions.

min_coverage

number

Minimum extraction coverage score by which to filter the retrieved extractions. For more information about scoring, see Monitoring extractions.

max_coverage

number

Maximum extraction coverage score by which to filter the retrieved extractions. For more information about scoring, see Monitoring extractions.

Response

200

application/json

Returns list of summarized extractions.

extractions

object[]

extractions.id

string

Unique ID for the extraction, used to retrieve the extraction

extractions.created

string

Date and time Sensible created the initial empty extraction and set its status to WAITING.

extractions.completed

string

Date and time Sensible set the extraction's status to COMPLETED

extractions.status

enum<string>

Status of the extraction:

WAITING: Sensible created an initial empty extraction and is waiting for the document.
PROCESSING: Sensible received the document and is extracting data.
FAILED: The extraction failed.
COMPLETE: The extraction is complete.

Available options:

WAITING,

PROCESSING,

COMPLETE,

FAILED

extractions.validation_summary

object

Summary of the extracted fields that fail validation rules you write in the Sensible app.

extractions.page_count

integer

Total number of pages in the document.

extractions.document_name

string

If you specify the filename of the document using the document_name parameter, then Sensible displays the name in extraction history in the Sensible app and returns the name in the extraction response.

extractions.environment

string

The environment in which the version of the config used to run the extraction was published.

extractions.coverage

number

The coverage score measures how fully an extraction captured all your target data in the document. It's a percentage comparing non-null, validated fields to total fields returned by a config for a document. For example, a coverage score of 70% for an extraction with no validation errors means that 30% of fields were null. For more information about scoring, see Monitoring extractions.

extractions.type

string

Unique user-friendly name for a document type

extractions.configuration

string

Name of the "configuration", a collection of SenseML queries for extracting document data.

extractions.errors

object[]

Extraction error messages.

extractions.validations

object[]

Which extracted fields failed validation rules you write in the Sensible app

cutoff_date

string

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.

Retrieve extraction by ID Get extraction statistics

curl --request GET \
  --url https://api.sensible.so/v0/extractions \
  --header 'Authorization: Bearer <token>'

{
  "extractions": [
    {
      "id": "246a6f60-0e5b-11eb-b720-295a6fba723e",
      "created": "2022-10-31T16:27:53.433Z",
      "completed": "2022-10-31T16:27:53.741Z",
      "status": "COMPLETE",
      "validation_summary": {
        "fields": 6,
        "fields_present": 4,
        "errors": 0,
        "warnings": 1,
        "skipped": 1
      },
      "page_count": 100,
      "document_name": "example.pdf",
      "environment": "DEVELOPMENT",
      "coverage": 0.75,
      "type": "auto_insurance_quotes_all_carriers",
      "configuration": "config_for_x_company",
      "errors": [
        {
          "field_id": "phone_number",
          "message": "ConfigurationError: width <=0",
          "type": "configuration"
        }
      ],
      "validations": [
        {
          "description": "Policy number must be 11 digits",
          "severity": "error"
        },
        {
          "description": "Company email must be in format string@string",
          "severity": "skipped",
          "message": "Missing prerequisites - company_email"
        }
      ]
    }
  ],
  "cutoff_date": null
}

Introduction

Extraction

Classification

Configuration

List extractions

Authorizations

Query Parameters

Response