Skip to main content
GET
Get a content check

Authorizations

Authorization
string
header
required

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

Path Parameters

checkId
string
required

Content check identifier.

Minimum string length: 1
Example:

"01HX7K2YV9D3M8N0G6Q5R4S3T2"

Response

The content check.

id
string
required
Minimum string length: 1
Example:

"01HX7K2YV9D3M8N0G6Q5R4S3T2"

workspaceId
string
required
url
string
required
status
enum<string>
required
Available options:
pending,
completed,
failed
createdDate
string
required
crawlerIdentity
enum<string>

The crawler identity that was impersonated when fetching the URL.

Available options:
ChatGPT-User,
OAI-SearchBot,
PerplexityCrawler,
GoogleBot
Example:

"ChatGPT-User"

sendOtterlyHeader
boolean

Whether the Otterly identifying header was sent when fetching the URL.

structuralAnalysis
object

How well the page is structured for machine reading, with per-category breakdowns.

dynamicContent
object

Comparison of the static (no-JS) page against the JavaScript-rendered page.

contentAnalysis
object

AI content-readiness analysis: per-dimension scores and recommendations for making the page easier for AI to quote and understand.