Skip to main content
GET
Reconcile objects vs documents

Authorizations

Authorization
string
header
required

Mixpeek API key, sent as Authorization: Bearer mxp_sk_.... Create one in Studio under Settings → API Keys, or with an admin key via POST /v1/organizations/users/{user_email}/api-keys. A missing header returns 403; an invalid or revoked key returns 401.

X-Namespace
string
header
required

Namespace id (ns_...), not the namespace name. This scopes the request rather than authenticating it, and it is required on every operation marked x-mixpeek-namespace-scoped.

Path Parameters

collection_identifier
string
required

The ID or name of the collection to reconcile

Query Parameters

limit
integer
default:100

Cap on the itemized discrepancies list.

Required range: 1 <= x <= 1000

Response

Successful Response

Objects-vs-documents conservation for one collection.

delta is the headline conservation number (source objects that produced no document). discrepancies is a bounded, itemized sample of those objects; discrepancies_truncated says whether more exist beyond limit so the caller never mistakes the sample for the whole.

collection_id
string
required
source_object_count
integer
required

Distinct source objects submitted to this collection.

produced_object_count
integer
required

Distinct source objects that produced >=1 document.

document_count
integer
required

Documents this collection has produced.

delta
integer
required

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

limit
integer
required

The cap applied to discrepancies.

discrepancies
ReconciliationDiscrepancy · object[]

Itemized objects that produced no document, up to limit.

discrepancies_truncated
boolean
default:false

True when more discrepancies exist than limit returned.