Get a scan

GET/scans/{scan_id}

Authorization

AuthorizationBearer token · headerrequired

API key sent as Authorization: Bearer <key>. A key belongs to one workspace, has scopes, and can be limited to some brands.

AuthorizationOAuth2 access token · headerrequired

OAuth 2.1 sign-in (authorization code with PKCE) used by AI assistants that connect through the Zaraftis MCP server. Discovery URLs are at https://api.zaraftis.com/api/auth.

Path parameters

scan_idstring<uuid>required

Query parameters

detailstring

compact (default) or detailed. Where a route returns more with detailed, its response description says what is added.

Allowed:compactdetailed

Responses

200

One scan with stored metrics (detail adds started_at and error_message)

successbooleanrequired

dataScanDetailrequired

Show properties

scan_idstring<uuid>required

matches ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

brand_idstring<uuid>required

matches ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

brand_namestringrequired

min length 1

statusstringrequired

Allowed:queuedrunningcompletedfailed

triggered_bystring | nullrequired

Show properties

Any of:

string

string

null

null

created_atstring<date-time>required

matches ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$

completed_atstring<date-time> | nullrequired

Show properties

Any of:

string<date-time>

string<date-time>

null

null

countrystringrequired

min length 2 · max length 2

languagestringrequired

min length 2 · max length 10

platformsstring[]required

prompt_countinteger | nullrequired

Show properties

Any of:

integer

integer

null

null

requestedinteger | nullrequired

Show properties

Any of:

integer

integer

null

null

completedinteger | nullrequired

Show properties

Any of:

integer

integer

null

null

failedintegerrequired

min 0 · max 9007199254740991

setup_idstring<uuid> | nullrequired

Show properties

Any of:

string<uuid>

string<uuid>

null

null

setup_version_idstring<uuid> | nullrequired

Show properties

Any of:

string<uuid>

string<uuid>

null

null

setup_checksumstring | nullrequired

Show properties

Any of:

string

string

null

null

metricsScanMetricsFieldMaprequired

started_atstring<date-time> | nullrequired

Show properties

Any of:

string<date-time>

string<date-time>

null

null

error_messagestring | nullrequired

request_idstringrequired

min length 1

404

not_found: unknown id, or an id this key cannot see

successbooleanrequired

errorobjectrequired

Show properties

codestringrequired

messagestringrequired

retryablebooleanrequired

detailsobject

field_errorsobject[]

Show properties

Array of object

fieldstringrequired

codestringrequired

Allowed:requiredformattoo_smalltoo_largeunrecognized_keyinvalid

messagestringrequired

request_idRequestIdrequired

Request

curl -X GET 'https://api.zaraftis.com/v1/scans/497f6eca-6276-4993-bfeb-53cbbbba6f08' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'

const response = await fetch("https://api.zaraftis.com/v1/scans/497f6eca-6276-4993-bfeb-53cbbbba6f08", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Accept": "application/json"
  }
});

import requests

response = requests.get(
    "https://api.zaraftis.com/v1/scans/497f6eca-6276-4993-bfeb-53cbbbba6f08",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Accept": "application/json"
    },
)

Response

{
  "success": true,
  "data": {
    "scan_id": "9a59f0f5-5572-476d-a7fc-c960ef43a5af",
    "brand_id": "1bb61461-e5e3-4ebb-8cc6-5b0c37f1b7da",
    "brand_name": "string",
    "status": "queued",
    "triggered_by": "string",
    "created_at": "2019-08-24T14:15:22Z",
    "completed_at": "2019-08-24T14:15:22Z",
    "country": "st",
    "language": "string",
    "platforms": [
      "string"
    ],
    "prompt_count": 0,
    "requested": 0,
    "completed": 0,
    "failed": 0,
    "setup_id": "223e7533-659b-4438-b6f4-f841a5d7dfa9",
    "setup_version_id": "46e86b42-ef3c-4109-b8e4-2fc5ae51285c",
    "setup_checksum": "string",
    "metrics": {
      "property1": {
        "value": 0,
        "quality": "complete",
        "method_version": "string"
      },
      "property2": {
        "value": 0,
        "quality": "complete",
        "method_version": "string"
      }
    },
    "started_at": "2019-08-24T14:15:22Z",
    "error_message": "string"
  },
  "request_id": "string"
}

{
  "success": false,
  "error": {
    "code": "string",
    "message": "string",
    "retryable": true,
    "details": {},
    "field_errors": [
      {
        "field": "string",
        "code": "required",
        "message": "string"
      }
    ]
  },
  "request_id": "string"
}