Sitemaps

For a list of methods for this resource, see the end of this page.

Resource representations

Contains detailed information about a specific URL submitted as a sitemap.

{
  "path": string,
  "lastSubmitted": datetime,
  "isPending": boolean,
  "isSitemapsIndex": boolean,
  "type": string,
  "lastDownloaded": datetime,
  "warnings": long,
  "errors": long,
  "contents": [
    {
      "type": string,
      "submitted": long,
      "indexed": long
    }
  ]
}
Property name Value Description Notes
contents[] list The various content types in the sitemap.
contents[].indexed long The number of URLs from the sitemap that were indexed (of the content type).
contents[].submitted long The number of URLs in the sitemap (of the content type).
contents[].type string The specific type of content in this sitemap. For example: web.

Acceptable values are:
  • "androidApp"
  • "image"
  • "iosApp"
  • "mobile"
  • "news"
  • "pattern"
  • "video"
  • "web"
errors long Number of errors in the sitemap. These are issues with the sitemap itself that need to be fixed before it can be processed correctly.
isPending boolean If true, the sitemap has not been processed.
isSitemapsIndex boolean If true, the sitemap is a collection of sitemaps.
lastDownloaded datetime Date & time in which this sitemap was last downloaded. Date format is in RFC 3339 format (yyyy-mm-dd).
lastSubmitted datetime Date & time in which this sitemap was submitted. Date format is in RFC 3339 format (yyyy-mm-dd).
path string The url of the sitemap.
type string The type of the sitemap. For example: rssFeed.

Acceptable values are:
  • "atomFeed"
  • "notSitemap"
  • "patternSitemap"
  • "rssFeed"
  • "sitemap"
  • "urlList"
warnings long Number of warnings for the sitemap. These are generally non-critical issues with URLs in the sitemaps.

Methods

delete
Deletes a sitemap from this site.
get
Retrieves information about a specific sitemap.
list
Lists the sitemaps-entries submitted for this site, or included in the sitemap index file (if sitemapIndex is specified in the request).
submit
Submits a sitemap for a site.