> ## Documentation Index > Fetch the complete documentation index at: https://promptwatch.com/docs/llms.txt > Use this file to discover all available pages before exploring further. # Sitemap Crawl Progress > Get sitemap crawl progress with counts and percentage ## OpenAPI ````yaml /v2/openapi.json get /sitemap/progress openapi: 3.0.0 info: title: Promptwatch API v2 description: >- API v2 for customer integrations with Promptwatch monitoring platform. This version provides improved structure, additional endpoints, and enhanced functionality. version: 2.0.0 contact: name: Promptwatch Support email: team@promptwatch.com url: https://promptwatch.com license: name: Commercial url: https://promptwatch.com/terms-and-conditions servers: - url: https://server.promptwatch.com/api/v2 description: Promptwatch API v2 security: [] tags: - name: Authentication description: API key validation and authentication - name: Content description: >- AI content generation and optimization. Create content asynchronously and poll for results. - name: Content Gap description: Content gap analysis and recommendations - name: Models description: Available LLM models - name: Monitors description: Monitor management and CRUD operations - name: Page Tracker description: Track URLs and inspect citation stats, responses, and prompts - name: Prompts description: Prompt management and operations - name: Query Fanouts description: ChatGPT query fanout keywords - name: Responses description: LLM response data and analytics - name: Tags description: Tag management for prompts - name: Topics description: Topic management for prompts - name: Actions description: Action items (GEO suggestions and tasks) - name: Personas description: Persona configuration for monitors - name: Brands description: Brand management for competitive analysis - name: Visibility description: Brand visibility time series and competitor heatmaps - name: Citations description: Citation analytics from AI responses - name: Analytics description: Visitor analytics, AI crawler logs, sentiment, and brand visibility trends - name: Projects description: Project management (organization-level keys only) - name: Sitemap description: Sitemap crawl progress and discovered URLs - name: Site Health description: >- Crawled pages with SEO issues (titles, meta descriptions, H1, thin content) - name: Socials description: >- Social media citations (Reddit posts and YouTube videos) found in LLM responses paths: /sitemap/progress: get: tags: - Sitemap summary: Sitemap Crawl Progress description: Get sitemap crawl progress with counts and percentage operationId: getSitemapProgress responses: '200': description: Default Response content: application/json: schema: type: object example: 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 properties: totalUrls: type: number crawledUrls: type: number notCrawledUrls: type: number successfulCrawls: type: number progressPercentage: type: number description: Percentage of URLs crawled (crawledUrls/totalUrls * 100) crawlHealthScore: type: number description: >- Percentage of all sitemap URLs successfully crawled (2xx + redirects) out of totalUrls (0-100) lastUpdated: type: string format: date-time httpStatusBreakdown: type: object properties: success: type: object properties: count: type: number percentage: type: number required: - count - percentage additionalProperties: false redirect: type: object properties: count: type: number percentage: type: number required: - count - percentage additionalProperties: false clientError: type: object properties: count: type: number percentage: type: number required: - count - percentage additionalProperties: false serverError: type: object properties: count: type: number percentage: type: number required: - count - percentage additionalProperties: false notCrawled: type: object properties: count: type: number percentage: type: number required: - count - percentage additionalProperties: false required: - success - redirect - clientError - serverError - notCrawled additionalProperties: false crawlAttempts: type: object properties: averageAttempts: type: number maxAttempts: type: number required: - averageAttempts - maxAttempts additionalProperties: false required: - totalUrls - crawledUrls - notCrawledUrls - successfulCrawls - progressPercentage - crawlHealthScore - lastUpdated - httpStatusBreakdown - crawlAttempts additionalProperties: false '401': description: Default Response content: application/json: schema: type: object example: error: Unauthorized message: Missing or invalid X-API-Key header. properties: error: type: string description: Error category (often aligned with HTTP semantics) code: type: string description: Optional machine-readable code message: type: string description: Human-readable explanation details: type: object description: Optional structured detail (e.g. validation) additionalProperties: true required: - error - message additionalProperties: false '500': description: Default Response content: application/json: schema: type: object example: code: INTERNAL_ERROR message: An unexpected error occurred properties: code: type: string description: Error code indicating the type of error enum: - INTERNAL_ERROR message: type: string description: Human-readable error message required: - code - message additionalProperties: false security: - ApiKeyAuth: [] components: securitySchemes: ApiKeyAuth: type: apiKey in: header name: X-API-Key description: >- API key for authentication. Get yours from the Promptwatch dashboard under Settings > API Keys. ````