Skip to main content
GET
/
sitemap
/
progress
Sitemap Crawl Progress
curl --request GET \
  --url https://server.promptwatch.com/api/v2/sitemap/progress \
  --header 'X-API-Key: <api-key>'
{
  "totalUrls": 500,
  "crawledUrls": 412,
  "notCrawledUrls": 88,
  "successfulCrawls": 380,
  "progressPercentage": 82.4,
  "crawlHealthScore": 76,
  "lastUpdated": "2026-03-30T08:00:00.000Z",
  "httpStatusBreakdown": {
    "success": {
      "count": 350,
      "percentage": 70
    },
    "redirect": {
      "count": 30,
      "percentage": 6
    },
    "clientError": {
      "count": 22,
      "percentage": 4.4
    },
    "serverError": {
      "count": 10,
      "percentage": 2
    },
    "notCrawled": {
      "count": 88,
      "percentage": 17.6
    }
  },
  "crawlAttempts": {
    "averageAttempts": 1.15,
    "maxAttempts": 4
  }
}

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

Percentage of all sitemap URLs successfully crawled (2xx + redirects) out of totalUrls (0-100)

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