Skip to main content
Scans

Get a scan's status and results

View Markdown

Returns a scan's status, progress, and per-check results. Polling this advances the scan — it fetches any newly-ready checks from DataForSEO. Poll until done is true. Free.

GET/v1/scans/{id}

Authorization

accessKey
x-access-key<token>

In: header

Path Parameters

id*string

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/scans/string"
{
  "success": true,
  "data": {
    "id": "string",
    "brandId": null,
    "brand": "string",
    "domain": null,
    "status": "string",
    "progress": {
      "total": 0,
      "completed": 0,
      "failed": 0,
      "pending": 0
    },
    "done": true,
    "prompts": [
      "string"
    ],
    "engines": [
      "string"
    ],
    "results": [
      {
        "prompt": "string",
        "engine": "string",
        "status": "string",
        "mentioned": null,
        "position": null,
        "competitors_found": [
          "string"
        ],
        "sentiment": null,
        "sources_count": 0,
        "error": null
      }
    ],
    "createdAt": "string",
    "completedAt": null
  }
}
{
  "success": false,
  "message": "string"
}
{
  "success": false,
  "message": "string"
}
{
  "success": false,
  "message": "string"
}