Sitemap and orphan-page audit

Audit sitemap coverage, sitemap-only orphan candidates, important URLs, canonical/indexability noise, and internal-link gaps. Costs 2 credits and does not call a paid search API.

post/site/sitemap-audit

Request

  • Base URL: https://www.agentseo.dev/api/v1
  • URL: https://www.agentseo.dev/api/v1/site/sitemap-audit
  • Auth: API key in header x-api-key

Query parameters

syncboolean

Open a short inline processing window when supported by the endpoint. If the result is not ready yet, the endpoint may still return 202 with a queued payload that includes poll_url, events_url, and retry_after_seconds.

Headers

x-project-idstring

Optional attribution label for grouping usage and jobs by project.

x-workflow-idstring

Optional attribution label for grouping usage and jobs by workflow or agent run.

Request body

targetstring

Optional target brand, domain, or product.

sitemap_urlstring uri

Sitemap URL to fetch.

sitemap_xmlstring

Raw sitemap XML.

max_sitemap_childreninteger
important_urlsstring[]

Response

Completed sitemap audit workflow with findings and agent_workflow

targetstring nullable
sitemap_auditobject
markdown_summarystring

Changes

No recorded changes to this operation across all 1 revision of this API.