Skip to main content
GET
Get chronology extraction status

Authorizations

Authorization
string
header
required

Workspace credential issued from the automation console at /automation. Send it as Authorization: Bearer vq_ws_.... This is NOT a Data API key: a vq_key_ credential is refused here and names the other product in the error.

Path Parameters

matterId
string
required

mat_ identifier of the matter to work inside. Everything in this API hangs off a matter, and the matter in the path is what the authorization boundary is checked against. Take it from GET /v1/matters.

Response

Successful Response

How far the automatic extraction has got across the whole matter.

documents
DocumentExtractionState · object[]
required

Per-document state, for every document extraction has touched.

totalDocuments
integer
required

Finished documents in the matter.

Example:

1

completedDocuments
integer
required

Documents whose extraction succeeded.

Example:

1

pendingDocuments
integer
required

Documents still waiting, including ones extraction has not reached yet and therefore has no per-document row for.

Example:

1

failedDocuments
integer
required

Documents whose extraction failed.

Example:

1

isExtractionComplete
boolean
required

True when nothing is outstanding and the matter had something to extract.

Example:

false

Last modified on August 23, 2026