SurfacedBySurfacedBy Docs
DocumentationAPIReference

Scans

Browse a domain's scan history and fetch one scan with its result payload.

Ask an AI:Open in ChatGPTOpen in Claude

A scan is one execution of your tracked prompts against the AI platforms your plan covers. Listing scans for a domain returns the full history in reverse chronological order with status, platform coverage, and timestamps. Fetching a specific scan returns the same record plus the raw result set the analytics endpoints are built on top of.

Scans are scheduled by your plan's cadence; you cannot create one via the Data API. Use the dashboard or the Console API for on-demand scans. Both endpoints here are read-only and available on Professional and Business.

GET
/domains/{domain_id}/scans
/domains/{domain_id}/scans

Path Parameters

domain_id
Required
Domain Id

Query Parameters

cursorCursor

Header Parameters

X-API-KeyX-Api-Key

curl -X GET "https://example.com/domains/string/scans?cursor=string" \
  -H "X-API-Key: string"

Successful Response

null

GET
/scans/{scan_id}
/scans/{scan_id}

Path Parameters

scan_id
Required
Scan Id

Header Parameters

X-API-KeyX-Api-Key

curl -X GET "https://example.com/scans/string" \
  -H "X-API-Key: string"

Successful Response

null

Previous

Reports

Next

Platforms