/webmasters/v3/sites/{siteUrl}/sitemaps/{feedpath}

GET

sitemaps

Retrieves information about a specific sitemap.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://searchconsole.googleapis.com//webmasters/v3/sites//sitemaps/'

Response Example

{
  "contents": [
    {
      "indexed": "string",
      "submitted": "string",
      "type": "WEB"
    }
  ],
  "errors": "string",
  "isPending": true,
  "isSitemapsIndex": true,
  "lastDownloaded": "string",
  "lastSubmitted": "string",
  "path": "string",
  "type": "NOT_SITEMAP",
  "warnings": "string"
}

Request

Path Params

siteUrl

string

required

The site's URL, including protocol. For example: http://www.example.com/.

feedpath

string

required

The URL of the actual sitemap. For example: http://www.example.com/sitemap.xml.

Responses

🟢200Successful response

application/json

Body

Contains detailed information about a specific URL submitted as a [sitemap](https://support.google.com/webmasters/answer/156184).

contents

array[object (WmxSitemapContent) {3}]

optional

The various content types in the sitemap.

indexed

string <int64>

optional

Deprecated; do not use.

submitted

string <int64>

optional

The number of URLs in the sitemap (of the content type).

type

enum<string>

optional

The specific type of content in this sitemap. For example: web.

Allowed values:

WEBIMAGEVIDEONEWSMOBILEANDROID_APPPATTERNIOS_APPDATA_FEED_ELEMENT

errors

string <int64>

optional

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

optional

If true, the sitemap has not been processed.

isSitemapsIndex

boolean

optional

If true, the sitemap is a collection of sitemaps.

lastDownloaded

string <google-datetime>

optional

Date & time in which this sitemap was last downloaded. Date format is in RFC 3339 format (yyyy-mm-dd).

lastSubmitted

string <google-datetime>

optional

Date & time in which this sitemap was submitted. Date format is in RFC 3339 format (yyyy-mm-dd).

path

string

optional

The url of the sitemap.

type

enum<string>

optional

The type of the sitemap. For example: rssFeed.

Allowed values:

NOT_SITEMAPURL_LISTSITEMAPRSS_FEEDATOM_FEEDPATTERN_SITEMAPOCEANFRONT

warnings

string <int64>

optional

Number of warnings for the sitemap. These are generally non-critical issues with URLs in the sitemaps.

Modified at 2023-08-15 09:03:48

/sites/{siteUrl}/sitemaps/{feedpath}