Skip to main content

siteMapPages

Returns pages of the Site's Spider site map and a status saying whether asking again will return more. Without query or pageType these are suggested pages, most important first; pass pages the user already added in excludeUrls to get the next ones. With query this is URL and title autocomplete, best match first: an exact path segment before a word or substring of the path, the path before the title, tolerating typos; importance only orders pages that match equally well. The first request for an empty map runs a quick crawl (up to about 10 seconds), returns the pages the Site's Recordings and Web Analytics already know, and queues a full crawl and their import, so the answer is partial: while PENDING, repeat every 10 to 30 seconds, backing off, until READY; on UNAVAILABLE, retry after retryAfterS or stop when it is null. Pages seen only in Recordings, Web Analytics or Google Analytics imports are returned only to users who may view Recordings. Requires site access.

siteMapPages(
  siteId: Int!
  query: String
  pageType: SiteMapPageType
  limit: Int
  excludeUrls: [String!]
): SiteMapPagesResult!

Arguments​

siteMapPages.siteId ● Int! non-null scalar​

Site ID from sites.

siteMapPages.query ● String scalar​

Autocomplete text, at most 200 characters, matched case-insensitively against the URL and the page title. Every word must match; words of 4 or more letters also match with a typo. A path (/pricing) or a URL with a host (example.com/pricing) matches that path and the pages under it.

siteMapPages.pageType ● SiteMapPageType enum​

Only confidently classified pages of this type. Quick-crawl pages are unclassified and never match.

siteMapPages.limit ● Int scalar​

Maximum number of pages, default 25. Values outside 1 to 50 are clamped to that range.

siteMapPages.excludeUrls ● [String!] list scalar​

At most 200 URLs to leave out before the limit applies, for example pages the user already added. Each is canonicalized like Spider's page URLs (case of scheme and host, default port, trailing slash, fragment, tracking parameters) and also excludes its http and https forms with and without one leading www.. An entry without a scheme (example.com/pricing) is read as http://; a relative one (/pricing) is ignored.

Type​

SiteMapPagesResult object​

Pages and discovery progress returned by siteMapPages; status describes pending work and coverage describes completed crawling.