{ "opencollection": "1.0.0", "info": { "name": "Sensible Classification Configuration Retrieve extractions API", "version": "v0" }, "request": { "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "items": [ { "info": { "name": "Retrieve extractions", "type": "folder" }, "items": [ { "info": { "name": "Get extraction statistics", "type": "http" }, "http": { "method": "GET", "url": "https://api.sensible.so/v0/extractions/statistics", "params": [ { "name": "start_date", "value": "2020-10-10T00:00:00.000Z", "type": "query", "description": "Retrieves statistics for configs used on this day and later. Sensible returns daily statistics, so if you specify a time in addition to a date, Sensible ignores the time." }, { "name": "end_date", "value": "2020-10-20T00:00:00.000Z", "type": "query", "description": "Retrieves daily statistics for configs used on this day and earlier." }, { "name": "environments", "value": "development", "type": "query", "description": "Specifies the comma-delimited list of environments for which to retrieve statistics, for example, `production`. If unspecified, returns statistics for all environments." } ] }, "docs": "Returns daily extraction coverage statistics as a `coverage_histogram` per config. Sensible returns coverage for each config that was used for at least one extraction performed in the specified environments in the specified time period. For more information about coverage, see [Monitoring extractions](https://docs.sensible.so/docs/metrics). For more information about the returned `coverage_histogram`, see the response model." }, { "info": { "name": "Retrieve extraction by ID", "type": "http" }, "http": { "method": "GET", "url": "https://api.sensible.so/v0/documents/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Unique ID for the extraction, used to retrieve the extraction." } ] }, "docs": "Use this endpoint in conjunction with asynchronous extraction requests to retrieve your results.\nYou can also use this endpoint to retrieve the results for documents extractions from the synchronous /extract endpoint.\nTo poll extraction status, check the `status` field in this endpoint's response.\nWhen the extraction completes, the returned status is `COMPLETE` and the response includes results in the\n`parsed_document` field. For fields in the extraction for which Sensible couldn't find a value" }, { "info": { "name": "List extractions", "type": "http" }, "http": { "method": "GET", "url": "https://api.sensible.so/v0/extractions", "params": [ { "name": "start_date", "value": "2020-10-10T00:00:00.000Z", "type": "query", "description": "Retrieves extractions with a `created` date that is equal to or later than this date-time. The default is the unix epoch. " }, { "name": "end_date", "value": "2024-01-20T00:00:00.000Z", "type": "query", "description": "Retrieves extractions with a `created` date that is equal to or earlier than this date-time. The default is the current date-time." }, { "name": "limit", "value": "100", "type": "query", "description": "Use the limit to define the number of items you recieve on each page of the paginated response. The default is 20." }, { "name": "continuation_token", "value": "eyJpZCI6IjRiNTg1Mjc4LWUwOWMtNGJiOS04ODJiLThmYjFhZTA3ZGU3ZiIsInVzZXIiOiJjMDI0Y2QxYy01ZMMzLTRhODItYjJlYS0yYzgwN2U0NDk4OGIiLCJjcmVhdGVkIjoiMjAyNC0wNS0wMVQyMjo11Do1NS43MzMaIn1", "type": "query", "description": "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." }, { "name": "configuration_ids", "value": "1417523c-f318-4037-90e9-ed7ade06031d,23be500b-4b7f-43dd-b0db-f06ec5c6c8de", "type": "query", "description": "Comma-delimited list of configurations by which to filter the retrieved extractions." }, { "name": "document_type_ids", "value": "4e95e3d0-8d69-49b0-9501-2cca8b902a45, 24d82783-b12b-4e70-b0ae-ca1ce35a9836", "type": "query", "description": "Comma-delimited list of document types by which to filter the retrieved extractions." }, { "name": "environments", "value": "PRODUCTION,DEVELOPMENT", "type": "query", "description": "Comma-delimited list of environments (PRODUCTION, DEVELOPMENT) by which to filter the retrieved extractions." }, { "name": "statuses", "value": "COMPLETE,WAITING", "type": "query", "description": "Comma-delimited list of statuses (WAITING, PROCESSING, FAILED, COMPLETE) by which to filter the retrieved extractions." }, { "name": "min_coverage", "value": "0.8", "type": "query", "description": "Minimum extraction coverage score by which to filter the retrieved extractions. For more information about scoring, see [Monitoring extraction metrics](https://docs.sensible.so/docs/metrics)." }, { "name": "max_coverage", "value": "1", "type": "query", "description": "Maximum extraction coverage score by which to filter the retrieved extractions. For more information about scoring, see [Monitoring extraction metrics](https://docs.sensible.so/docs/metrics)." }, { "name": "review_statuses", "value": "APPROVED,NEEDS_REVIEW", "type": "query", "description": "Comma-delimited list of review statuses (APPROVED, NEEDS_REVIEW, REJECTED) by which to filter the retrieved extractions. For more information, see [Human review](https://docs.sensible.so/docs/human-review). Sensible returns [portfolio](https://docs.sensible.so/docs/portfolio) extractions if at least one document in the portfolio meets the specified status criteria. " } ] }, "docs": "Use this endpoint to get a filtered list of past extractions.\nThis endpoint returns a summary for each extraction, listed in reverse chronological order. \nTo get details about an extraction, use the [Retrieve extraction by ID](https://docs.sensible.so/reference/retrieving-results) endpoint.\nThis endpoint uses keyset pagination to retrieve the next page of results.\nBy default it returns a first page of 20 extractions and an opaque `continuation_token` that you can pass in the next request to get " } ] } ], "bundled": true }