ZUzuva
Field Extraction

Get extraction requests

Changed on

Retrieves the status of one or more extraction requests. Each request ID should be provided as a query parameter, e.g. /extractions?request_id=abcde&request_id=fghijk

If any or all request ids are invalid or not found, the overall response will be 200 Success, and the response body will contain the individual error messages for each request id.

A maximum of 1000 request IDs can be included in a single query.

get/extractions

Request

Query parameters

request_idstring[] required

Extraction request IDs

Response

The status of multiple extraction requests

errorsobject required
num_errorsinteger required
num_foundinteger required
statusesobject required

Example response

{
  "errors": {
    "cc1oi51qqhquidfjhiu0": {
      "error": {
        "code": "request_not_found",
        "message": "The specified request ID cannot be found"
      }
    }
  },
  "num_errors": 1,
  "num_found": 1,
  "statuses": {
    "cc1oi51qqhquidfjmiu0": {
      "file_id": "cc1ohrhqqhqthd7h5lag",
      "status": "complete",
      "request_id": "cc1oi51qqhquidfjmiu0"
    }
  }
}

Changes

  • 51f2a4c5de2eRevision changes
    • warning

      removed the optional property // from the response with the status

    • info

      for the query request parameter request_id, the type was generalized from string to array