List activities
Background work in progress or recently finished, newest first: each batch of reports being analysed, with every item's status, progress and the report and candidate it belongs to. Poll it, or one batch with GET /v1/activities/{id}, to follow work started in the app; GET /v1/reports/{id} is the way to follow a single report. 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. Pages hold at most 20.
Required scope: reports:read (reports:write also works).
Errors
- 400:
invalid_cursor,unknown_field - 401:
authentication_required,invalid_api_key - 403:
api_access_disabled,insufficient_scope - 422:
invalid_parameter - 429:
rate_limit_exceeded - 500:
api_error - 503:
service_unavailable
ApiKeyAuthorizationBearer <probb_live_<id>_<secret>>limit?integerPage size, 1 to 20. Defaults to 20.
1 <= value <= 2020cursor?stringThe nextCursor from the previous page.
1 <= length <= 2048Success.
application/json- response
object*stringdata*array<>The activities on this page.
hasMore*booleanWhether another page follows.
nextCursor*|Pass as cursor to fetch the next page, or null at the end.
# 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" \ -H "Authorization: Bearer $PROBB_API_KEY"{ "object": "list", "data": [ { "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" } ], "hasMore": true, "nextCursor": "string"}