Skip to content

List extraction schemas

GET
/api/v1/extraction/schemas
curl --request GET \
--url 'https://dashboard.justcrawl.io/api/v1/extraction/schemas?pageType=product&limit=50' \
--header 'Authorization: Bearer <token>'

Read-only list of XPath schemas the platform has discovered for cross-org sites. Schemas are global by design — they describe page structure, not tenant data, so the same (domain, pageType) pair is shared across all orgs that scrape it. Org-specific overrides live on the /attributes/{domain} endpoint and are merged at extraction time.

domain
string

Optional. Filter to one site (e.g. walmart.com).

pageType
string
Allowed values: product product_list serp article job_posting bestseller

Optional. Filter to one page-type taxonomy.

limit
integer
default: 50 <= 200

Page size cap. Values above 200 are clamped to 200.

List of extraction schemas.

Media type application/json
object
items
Array<object>
object
id
string
domain
string
pageType
string
Allowed values: product product_list serp article job_posting
version
integer
attributes
Array<object>
object
name
required
string
xpaths
required
Array<string>
type
required
string
Allowed values: text number url boolean text[] url[]
description
string
nullable
antiPatterns
Array<string>
nullable
semanticType
string
nullable
Allowed values: brand_name review_count product_id product_image star_rating
validation
object
minLength
integer
maxLength
integer
min
number
max
number
pattern
string
confidence
number
discoveredBy
string
Allowed values: llm llm_multi_sample manual reverse_engineered
sampleCount
integer
lastValidatedAt
string format: date-time
expiresAt
string format: date-time
createdAt
string format: date-time
Example
{
"items": [
{
"pageType": "product",
"attributes": [
{
"type": "text",
"semanticType": "brand_name"
}
],
"discoveredBy": "llm"
}
]
}

Missing or invalid authentication token

Media type application/json
object
error
string
Example
{
"error": "Missing or invalid authentication token"
}

Insufficient permissions for this operation

Media type application/json
object
error
string
Example
{
"error": "No organization. Complete onboarding first."
}

Unexpected server error. Logs and PostHog $exception capture

Media type application/json
object
error
string
Example
{
"error": "Something went wrong"
}