Skip to main content
GET
Get a crawlability check

Authorizations

Authorization
string
header
required

Provide your API key as a Bearer token: Authorization: Bearer YOUR_API_KEY.

Path Parameters

checkId
string
required

Crawlability check identifier.

Minimum string length: 1
Example:

"01HX7K2YV9D3M8N0G6Q5R4S3T2"

Response

The crawlability check.

id
string
required
Minimum string length: 1
Example:

"01HX7K2YV9D3M8N0G6Q5R4S3T2"

workspaceId
string
required
url
string
required
domain
string
required
status
enum<string>
required
Available options:
pending,
completed,
failed
createdDate
string
required
completedDate
string
robotsTxtAnalysis
object
robotsTxtAnalysisResult
boolean
serverBotAccess
object

Per-bot probe results. Keys are crawler names as they appear in robots.txt / User-Agent (e.g. GPTBot, PerplexityBot, ClaudeBot, Google-Extended, OAI-SearchBot, ChatGPT-User); values describe whether each bot was able to fetch the resource.