Job status and progress, and the summary (passed, failed, issuesBySeverity) once the job is terminal. With ?wait=, held until the job ends or the seconds pass.

get/jobs/{id}

Request

  • Base URL: https://app.difficat.com/api/v1
  • URL: https://app.difficat.com/api/v1/jobs/{id}
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer

Path parameters

idstring required

Query parameters

waitinteger

Seconds to hold the response until the job is terminal. A job still running when they pass is answered as it stands, so call again. Any other value is 400.

Response

OK

jobIdstring required
status'running' | 'completed' | 'failed' | 'cancelled' required
errorstring
createdAtinteger

Epoch ms.

updatedAtinteger

Epoch ms.

Example response

{
  "summary": {
    "totalPages": 3,
    "totalDiscovered": 3,
    "passed": 1,
    "failed": 2,
    "duration": 4.4,
    "startedAt": "2026-09-27T13:57:14.470Z",
    "completedAt": "2026-09-27T13:57:18.870Z",
    "byType": {
      "existence": {
        "passed": 2,
        "failed": 1
      },
      "content": {
        "passed": 1,
        "failed": 1
      },
      "visual": {
        "passed": 1,
        "failed": 1
      }
    },
    "issuesBySeverity": {
      "critical": 1,
      "high": 1,
      "medium": 1
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.