The API allows users to check the status of their submitted data scan requests. Users can provide a single tracking ID or a list of tracking IDs to receive the current status of each scan.
Route: /data-scan/status
Method: PUT
For authentication, include the following token in the request headers:
Headers: {“Authorization”: “Bearer <AUTH_TOKEN>”}
Note: To obtain the <auth token>, please refer to the Step-by-Step Guide to Obtain Your Auth Token.
Request Payload:
Eg Json
["354d2d30-178a-4220-9ce5-97908aa5713015052025072328"]
- A list of tracking_id values can also be given to check the status of multiple scans.
Response:
{
"data": [
{
"request_status": "SUCCESS",
"submitted_at": "2025-05-15 07:23:28.000000",
"process_started_at": "2025-05-15 07:23:29.000000",
"process_ended_at": "2025-05-15 07:23:33.000000",
"error_msg": "",
"input_payload": [
{
"data_samples": [
{
"column_name": "CustomerID",
"samples": [
"CID32",
"CID34",
"CID56",
"CID58"
]
},
{
"column_name": "email",
"samples": [
"John@gmail.com",
"Williams.hary@yahoo.com"
]
}
],
"data_source_name": "salesforce",
"object_name": [
"CustomerDB",
"Marketingschema",
"Customerstable"
]
}
],
"tracking_id": "354d2d30-178a-4220-9ce5-97908aa5713015052025072328"
}
],
"success": true,
"error": {
"message": ""
}
}
Returns a JSON object with the following keys:
- tracking_id: The unique identifier for the scan request.
- status: The current status of the scan. Possible values are:
- PENDING
- IN-PROGRESS
- SUCCESS
- FAILED
