Get a document refresh

Required scope: document-refreshes:read.

Returns a document refresh. state is queued, running, succeeded, partial, failed or cancelled, and reason explains failures.

counts reports the documents discovered, the required downloads that completed, and those that failed. A refresh that finds no new documents succeeds with zero downloads; one where some downloads failed is partial. last_successful_refresh_at only advances when a refresh fully succeeds.

GET /api/v2/document-refreshes/{id}
Bearer token scope document-refreshes:read

Path parameters

· 1
id string required

Document refresh ID.

Responses