# Batch Status

Once a batch of job posts has been submitted for mining, see Mining a Batch of Job Posts, you can check the status of the batch.

We have automatic measures in place that will temporarily pause the processing of the batch if the success rate is too low so that we can investigate the issue or amend the processing rate if the employer's website is experiencing issues.


# API Endpoint

To fetch the batch of mining jobs status, use the following API endpoint:

GET /v1/recruitment/job-posts/batch/status/

# Headers

Name Type Required Description
Authorization string See Authentication
Content-Type string Media type of the request. Should be application/json.

# Query Parameters

Parameter Type Required Description
batchId string Unique identifier for the batch, returned from the Mining a Batch of Job Posts endpoint.

# Code Sample

GET /v1/recruitment/job-posts/batch/status

curl -X GET 'https://services.automation.cloud/v1/recruitment/job-posts/batch/status' \
    -H 'Authorization: Basic <credentials>' \
    -H 'Content-Type: application/json' \
    -L \
    -d 'batchId=example123'

# Success Responses

If the request is successful, the API returns a 200 OK status with a response like this:

{
  "batchId": "7def85cc-3f68-401f-8315-f5472ebbb44c",
  "createdAt": 1741272947622,
  "state": "processing",
  "processedRate": 0.607,
  "successRate": 1
}

☝️ The state of the batch can be created, processing, paused, resumed or finished, as defined below.

State Description
created The batch has been created but not yet processed.
processing The batch is currently being processed. Progress will be shown by the processedRate property.
paused The batch has been paused due to low success rate and is currently under investigation.
resumed The batch has been resumed after being paused. It will shortly revert to processing.
finished The batch has been processed and all job posts have attempted to be mined.

# Error Handling

  • 401 Unauthorized – Invalid or missing API key.
  • 500 Internal Server Error – UBIO system error, try again later.
  • 404 Not Found – The batchId does not exist or is invalid.