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": 123,
  "crawledUrls": 123,
  "notCrawledUrls": 123,
  "successfulCrawls": 123,
  "progressPercentage": 123,
  "crawlHealthScore": 123,
  "lastUpdated": "2023-11-07T05:31:56Z",
  "httpStatusBreakdown": {
    "success": {
      "count": 123,
      "percentage": 123
    },
    "redirect": {
      "count": 123,
      "percentage": 123
    },
    "clientError": {
      "count": 123,
      "percentage": 123
    },
    "serverError": {
      "count": 123,
      "percentage": 123
    },
    "notCrawled": {
      "count": 123,
      "percentage": 123
    }
  },
  "crawlAttempts": {
    "averageAttempts": 123,
    "maxAttempts": 123
  }
}

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 successful crawls (0-100)

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