get/api/v2/sitemap/progress

Return sitemap crawl progress.

Return sitemap crawl progress.

Requires bearer API key

Parameters

X-Project-Id

header

Required for organization-wide API keys on project-scoped endpoints. Project-scoped keys infer the project automatically.

Schema: string

Responses

200

Successful JSON response.

application/json
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "totalUrls": {
      "type": "integer"
    },
    "crawledUrls": {
      "type": "integer"
    },
    "notCrawledUrls": {
      "type": "integer"
    },
    "successfulCrawls": {
      "type": "integer"
    },
    "progressPercentage": {
      "type": "number"
    },
    "crawlHealthScore": {
      "type": "integer"
    },
    "lastUpdated": {
      "type": "string",
      "format": "date-time",
      "nullable": true
    },
    "httpStatusBreakdown": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "success": {
          "type": "object",
          "additionalProperties": false,
          "properties": {
            "count": {
              "type": "integer"
            },
            "percentage": {
              "type": "number"
            }
          },
          "required": [
            "count",
            "percentage"
          ]
        },
        "redirect": {
          "type": "object",
          "additionalProperties": false,
          "properties": {
            "count": {
              "type": "integer"
            },
            "percentage": {
              "type": "number"
            }
          },
          "required": [
            "count",
            "percentage"
          ]
        },
        "clientError": {
          "type": "object",
          "additionalProperties": false,
          "properties": {
            "count": {
              "type": "integer"
            },
            "percentage": {
              "type": "number"
            }
          },
          "required": [
            "count",
            "percentage"
          ]
        },
        "serverError": {
          "type": "object",
          "additionalProperties": false,
          "properties": {
            "count": {
              "type": "integer"
            },
            "percentage": {
              "type": "number"
            }
          },
          "required": [
            "count",
            "percentage"
          ]
        },
        "notCrawled": {
          "type": "object",
          "additionalProperties": false,
          "properties": {
            "count": {
              "type": "integer"
            },
            "percentage": {
              "type": "number"
            }
          },
          "required": [
            "count",
            "percentage"
          ]
        }
      },
      "required": [
        "success",
        "redirect",
        "clientError",
        "serverError",
        "notCrawled"
      ]
    },
    "crawlAttempts": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "averageAttempts": {
          "type": "number"
        },
        "maxAttempts": {
          "type": "integer"
        }
      },
      "required": [
        "averageAttempts",
        "maxAttempts"
      ]
    }
  },
  "required": [
    "totalUrls",
    "crawledUrls",
    "notCrawledUrls",
    "successfulCrawls",
    "progressPercentage",
    "crawlHealthScore",
    "lastUpdated",
    "httpStatusBreakdown",
    "crawlAttempts"
  ]
}

Try it

Send this request to the local WatchLLM REST handler. Use a key from `/workspace/api`; organization keys can include `X-Project-Id` only when the endpoint documents that header.