Skip to main content
Web CrawlerVersion: v3

Get crawling status for the latest operation

GET/knowledge-bases/crawler/status

Fetches crawl/train progress for a specific operation, or the latest operation when operationId is omitted. WHEN TO USE: use this when you need to poll a discoverWebsite or trainDiscoveredUrls run; do not use it to start a crawl or train pages. RETURNS: aggregated counts by status plus detailed operation information.

Authorizations

Authorizationstringheaderrequired

Bearer authentication header of the form Bearer <token>, where <token> is your access token.

Scope:knowledge-bases.readonly
Auth methods:OAuthPrivate Integration
Token type:Sub-Account Token

Request​

Headers

Versionstringrequired

API Version

Available optionsv3
Example:v3

Query Parameters

locationIdstringrequired

Location ID as string

Example:tDtDnQdgm2LXpyiqYvZ6
operationIdstring

operation id as string (optional - gets latest if not provided)

Example:688b640bcb02d498102a13f0
knowledgeBaseIdstringrequired

knowledge base id

Example:RXzAdYGknD2phAoln3Jl

Response

Operation status fetched successfully

aggregateobject[]required

Aggregated crawling results by status

operationDetailsobjectrequired

Detailed operation information