Collections

Reconcile objects vs documents

Changed on

Objects-vs-documents conservation for a collection. Returns the distinct source-object count, the count that produced at least one document, the document count, and their delta, plus an itemized (bounded) list of source objects that produced no document with a machine-readable reason for each.

get/v1/collections/{collection_identifier}/reconciliation

Request

  • Base URL: https://api.mixpeek.com
  • URL: https://api.mixpeek.com/v1/collections/{collection_identifier}/reconciliation
  • Auth: HTTP bearer and API key in header X-Namespace

Path parameters

collection_identifierstring required

The ID or name of the collection to reconcile

Query parameters

limitinteger

Cap on the itemized discrepancies list.

Response

Successful Response

collection_idstring required
source_object_countinteger required

Distinct source objects submitted to this collection.

produced_object_countinteger required

Distinct source objects that produced >=1 document.

document_countinteger required

Documents this collection has produced.

deltainteger required

source_object_count - produced_object_count: source objects that produced no document. 0 means conservation holds.

discrepancies_truncatedboolean

True when more discrepancies exist than limit returned.

limitinteger required

The cap applied to discrepancies.

Changes

  • 61a175e8eb9aRevision 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

  • b40f559d564aRevision changes
    • info

      endpoint added