Sitemap analysis endpoint

XML Sitemap Inspector API

Audit what a site says should be crawled and compare it with the live technical state of listed pages. The response always separates discovered URLs from inspected URLs.

Get an API key Read documentation

Web pages passing through a processing grid and becoming structured data cards

Endpoint

POST /v1/sitemap-inspector

A working request

Set your key once in a server-side environment variable, then send a JSON request.

cURL

curl --request POST \
  --url "https://api.tooltrace.io/v1/sitemap-inspector" \
  --header "X-ToolTrace-Key: ${TOOLTRACE_KEY}" \
  --header "Content-Type: application/json" \
  --data '{
  "url": "https://example.com/sitemap.xml",
  "max_urls": 25,
  "summary_only": true
}'

Response scope

What the API returns

The response is structured for software, with source evidence kept beside the extracted or inspected data.

Sitemap discovery method
XML document findings
Sitemap index and child document data
Discovered and inspected URL counts
Live status, redirect, robots, canonical, and noindex evidence
Summary-only mode for compact automation

Practical uses

Publishing checks

Confirm that important public URLs appear in a usable sitemap after a release.

Migration audits

Find old redirects, missing pages, canonical conflicts, and stale sitemap entries after URL changes.

Scheduled monitoring

Track sitemap health with bounded requests and compact summary responses.

Implementation guidance

Use the result with context.

A valid file can still contain bad URLs

XML validation checks document structure. Live inspection checks whether listed pages return useful responses and agree with robots, noindex, redirect, and canonical signals.

Fix errors, blocked URLs, noindex conflicts, and canonical mismatches before lower-priority formatting warnings.

Read the scope fields

The API can inspect only a bounded number of URLs in one request. Always read discovered_urls, inspected_urls, inspection_complete, and limit_reason before treating a report as complete.

Authentication, limits, and errors

Send your key through the X-ToolTrace-Key header from server-side code. Read credit and rate-limit headers after every request. Validation, blocked destination, authentication, plan, and upstream fetch errors use structured responses that applications should handle by code rather than message text.

Use a dedicated key for each environment. Review current fields in the interactive API reference and compare usage limits on the pricing page.