Bucket Batches

Get Failed Documents for Batch

Changed on

Retrieve failed documents for a batch, optionally filtered by tier or collection.

get/v1/buckets/{bucket_identifier}/batches/{batch_id}/failed-documents

Request

  • Base URL: https://api.mixpeek.com
  • URL: https://api.mixpeek.com/v1/buckets/{bucket_identifier}/batches/{batch_id}/failed-documents
  • Auth: HTTP bearer and API key in header X-Namespace

Path parameters

bucket_identifierstring required

The unique identifier of the bucket.

batch_idstring required

The unique identifier of the batch.

Query parameters

tier_numinteger nullable
collection_idstring nullable
limitinteger
offsetinteger

Response

Successful Response

object required

Changes

    • warning

      removed the optional property from the response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the optional property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      the endpoint scheme security BearerAuth AND NamespaceHeader was added to the API