API reference
Retrieve a candidate feedback draft batch
GET
How far a bulk draft has got: counts of reports queued, drafted, unsupported and failed, whether the batch is done, and one item per report with its status, reason and, once drafted, the draft's ID. Poll it every few seconds; drafting a full batch takes about a minute. Changes nothing. Answers resource_not_found for a batch that does not belong to this job.
Required scope: reports:read (reports:write also works).
Errors
- 400:
unknown_field - 401:
authentication_required,invalid_api_key - 403:
api_access_disabled,insufficient_scope - 404:
job_not_found,resource_not_found - 422:
invalid_parameter - 429:
rate_limit_exceeded - 500:
api_error - 503:
service_unavailable
ApiKeyheader
AuthorizationBearer <probb_live_<id>_<secret>>jobId*stringThe job's ID.
Length
1 <= length <= 200batchId*stringThe batch's ID, from the draft request.
Length
1 <= length <= 200Success.
application/json- response
object*stringid*stringThe batch's ID, to follow with GET /v1/jobs/{jobId}/candidate-kits/draft/{batchId}.
jobId*stringThe job.
createdAt*stringFormat
date-timedone*booleanTrue when nothing is left queued: every report is drafted, skipped or failed.
counts*items*array<># Set PROBB_URL and PROBB_API_KEY. Replace any *_VALUE placeholder and any example ID (such as job_example) with a real one.curl --fail-with-body -X GET "$PROBB_URL/api/v1/jobs/JOB_ID_VALUE/candidate-kits/draft/BATCH_ID_VALUE" \ -H "Authorization: Bearer $PROBB_API_KEY"Example Response
{ "object": "candidate_kit_batch", "id": "string", "jobId": "string", "createdAt": "2019-08-24T14:15:22Z", "done": true, "counts": { "queued": -9007199254740991, "drafted": -9007199254740991, "unsupported": -9007199254740991, "failed": -9007199254740991 }, "items": [ { "reportId": "string", "status": "queued", "reason": "legacy_version", "message": "string", "candidateKitId": "string" } ]}