This API allows you to track the status of a background job created for a user request. You need to provide the tracking ID as input. The API will return details such as who requested the job, the time of the request, the job end time, the job status, any error messages if the status is FAILED, and the response if the status is SUCCESS. If the status is IN-PROGRESS or PENDING, the response and error message will be null. The status can be SUCCESS, IN-PROGRESS, PENDING, or FAILED.
NOTE: Only namespace admins with “metadata_change” permission who also requested the background job can access this route. For other users, it will return a permission denied error.
METHOD: GET
ROUTE: /namespace/job-status
Headers:
{
“Authorization”: “Bearer <NAMESPACE_ADMIN_API_KEY>”
}
Query params:
tracking_id : “9f799cb6-5315-4199-8d47-3a7ced21dd1d29042024113301”
Response structure:
{
"data": {
" tracking_id": "9f799cb6-5315-4199-8d47-3a7ced21dd1d29042024113301",
"requested_user": "user1@email.com ",
"requested_timestamp": "2024-05-28 18:23:42.168187"
"process_end_time": "2024-05-28 18:23:51.168187" "job_type ": "data-deletion",
"status": "SUCCESS",
"response": {
"cleared_records": 150,
"message": "Records older than the specified date has been cleared successfully."
},
"error_message": ""
},
"success": true,
"error": {"message": ""}}
