Get Consortium Search Batch

get/consortium/searches/batches/{batch_id}

Path parameters

batch_idstring uuid required

Successful Response

idstring uuid required

The batch's id, used to poll status and fetch results.

state'PENDING' | 'EXECUTING' | 'COMPLETED' | 'FAILED' | 'CANCELLED' required

progressnumber nullable

Fraction of entries processed so far, in [0, 1].

completed_countinteger nullable

Number of entries processed so far.

total_countinteger nullable

Total number of entries in the batch.

created_atstring date-time required

When the batch was accepted.

{
  "total_count": 100
}

No recorded changes to this endpoint across all 1 revision of this API.