Skip to main content
GET
Sitemap Crawl Progress

Authorizations

X-API-Key
string
header
required

API key for authentication. Get yours from the Promptwatch dashboard under Settings > API Keys.

Response

Default Response

totalUrls
number
required
crawledUrls
number
required
notCrawledUrls
number
required
successfulCrawls
number
required
progressPercentage
number
required

Percentage of URLs crawled (crawledUrls/totalUrls * 100)

crawlHealthScore
number
required

Share of sitemap URLs crawled successfully (2xx and redirects) out of totalUrls, from 0 to 100. This is crawl coverage, not the site audit health score from GET /site-audit/runs.

lastUpdated
string<date-time>
required
httpStatusBreakdown
object
required
crawlAttempts
object
required