API reference
Retrieve an activity
GET
One batch of background work with the status and progress of each item. Activities belong to the person who started them, so a key sees the batches started by the person who created it, as that person sees them in the app.
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:
activity_not_found - 422:
invalid_parameter - 429:
rate_limit_exceeded - 500:
api_error - 503:
service_unavailable
ApiKeyheader
AuthorizationBearer <probb_live_<id>_<secret>>id*stringThe activity's ID.
Length
1 <= length <= 200Success.
application/json- response
object*stringid*stringThe activity's ID.
kind*"resume_analysis"What the work is. Today every activity is a batch of reports.
Value in
"resume_analysis"title*stringThe job the batch was run for.
status*stringThe batch as a whole: needs_review while any item does, else processing or queued while any is active, failed when every item failed, otherwise completed (some items may have failed; see counts).
Value in
"queued""processing""needs_review""completed""failed"counts*items*array<>One item per report.
createdAt*stringWhen the batch was started.
Format
date-time# 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/activities/ID_VALUE" \ -H "Authorization: Bearer $PROBB_API_KEY"Example Response
{ "object": "activity", "id": "string", "kind": "resume_analysis", "title": "string", "status": "queued", "counts": { "total": -9007199254740991, "active": -9007199254740991, "completed": -9007199254740991, "failed": -9007199254740991, "needsReview": -9007199254740991 }, "items": [ { "id": "string", "status": "queued", "progress": 0, "score": 0, "name": "string", "report": { "id": "string" }, "candidate": { "id": "string" }, "job": { "id": "string" } } ], "createdAt": "2019-08-24T14:15:22Z"}