Skip to main content
WEB_MAP lists a site’s addresses without reading their content. One task reads the start page for its links, robots.txt for the sitemaps it names (or /sitemap.xml and /sitemap_index.xml when it names none), and those sitemaps. Use it to pick pages for WEB_SCRAPE or to scope a WEB_CRAWL.

Request

Parameters

In a pattern, * matches within one path segment and ** matches across segments; every other character matches itself. /blog/** also matches /blog. Paths are matched percent-decoded. The site is the host the start address lands on after redirects, with or without www..

Response

For example:

Limits and errors

  • The task fails with PAGE_UNAVAILABLE when no address matches includePaths and excludePaths, or when the start page cannot be read and the site lists no sitemap.
  • Invalid options return 422 VALIDATION_ERROR naming the field.
  • WEB_MAP ignores markdown, rawResponse and searchQueries. It rejects html and analysis with 422 and citationAnalysis with 400; see unsupported flags.
  • Other request errors are listed in Errors.