Track status of an audit

GET /v1/audit/status/{id}
Api key

Tracks status of an audit

Path parameters

  • id string Required

    Tracking Id

    Maximum length is 50.

Responses

  • • 200

    Successful response.

    Hide response attributes Show response attributes object
    • trackingId string
    • url string
    • status string

      Values are not-started, in-progress, or completed.

    • auditId string

      The auditId for the audit data.


      Please note that the auditId field is only visible if the value of the status field in the data object is completed.
  • • 404

    Resource Not Found

    Hide response attributes Show response attributes object
    • message string

      A human-readable message providing more details about the error.

    • status string

      A status describing the situation
GET /v1/audit/status/{id} 
curl \
 -X GET https://api.auditzy.com/v1/audit/status/{id} \
 -H "X-ADZ-KEY: $API_KEY"
Response examples (200) 
{
  "data": {
    "trackingId": "DgUYKmQWzyxjrZRf",
    "url": "https://auditzy.com",
    "status": "completed",
    "auditId": "5bc1d69b-d8d-758b6-dc3-da306fd8355c"
  },
  "status": "SUCCESS"
}
Response examples (404) 
{
  "message": "Resource Not Found",
  "status": "FAILURE"
}