Sitemaps: get
Stay organized with collections
Save and categorize content based on your preferences.
Requires authorization
Retrieves information about a specific sitemap. Try it now
.
Request
HTTP request
GET https://www.googleapis.com/webmasters/v3/sites/ siteUrl
/sitemaps/ feedpath
Parameters
Parameter name
Value
Description
feedpath
string
The URL of the actual sitemap. For example: http://www.example.com/sitemap.xml
siteUrl
string
The URL of the property as defined in Search Console. For example: http://www.example.com/
( URL-prefix
property),
or sc-domain:example.com
( Domain
property).
Authorization
This request requires authorization with at least one of the following scopes ( read more about authentication and authorization
).
Request body
Do not supply a request body with this method.
Response
If successful, this method returns a Sitemaps resource
in the response body.
Try it!
Use the APIs Explorer below to call this method on live data and see the response.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License
, and code samples are licensed under the Apache 2.0 License
. For details, see the Google Developers Site Policies
. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-07-23 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-07-23 UTC."],[[["\u003cp\u003eRetrieves data for a specified sitemap using its URL and the site's URL as registered in Google Search Console.\u003c/p\u003e\n"],["\u003cp\u003eRequires authorization with either \u003ccode\u003ehttps://www.googleapis.com/auth/webmasters.readonly\u003c/code\u003e or \u003ccode\u003ehttps://www.googleapis.com/auth/webmasters\u003c/code\u003e scope.\u003c/p\u003e\n"],["\u003cp\u003eUses an HTTP GET request with \u003ccode\u003efeedpath\u003c/code\u003e and \u003ccode\u003esiteUrl\u003c/code\u003e as path parameters.\u003c/p\u003e\n"],["\u003cp\u003eReturns a Sitemaps resource with information about the requested sitemap if successful.\u003c/p\u003e\n"]]],["This outlines how to retrieve information about a specific sitemap via a `GET` request to `https://www.googleapis.com/webmasters/v3/sites/siteUrl/sitemaps/feedpath`. The request requires authorization using either the `webmasters.readonly` or `webmasters` scope. Two path parameters, `feedpath` (sitemap URL) and `siteUrl` (property URL), are needed. No request body is required; a successful response returns a Sitemaps resource.\n"],null,["# Sitemaps: get\n\n**Requires [authorization](#auth)**\n\nRetrieves information about a specific sitemap.\n[Try it now](#try-it).\n\nRequest\n-------\n\n### HTTP request\n\n```\nGET https://www.googleapis.com/webmasters/v3/sites/siteUrl/sitemaps/feedpath\n```\n\n### Parameters\n\n| Parameter name | Value | Description |\n|----------------|----------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| **Path parameters** |||\n| `feedpath` | `string` | The URL of the actual sitemap. For example: `http://www.example.com/sitemap.xml` |\n| `siteUrl` | `string` | The URL of the property as defined in Search Console. For example: `http://www.example.com/` ([URL-prefix](https://support.google.com/webmasters/answer/34592#url_prefix_prop_tips) property), or `sc-domain:example.com` ([Domain](https://support.google.com/webmasters/answer/34592#domain_property) property). |\n\n### Authorization\n\nThis request requires authorization with at least one of the following scopes ([read more about authentication and authorization](/webmaster-tools/v1/how-tos/authorizing)).\n\n| Scope |\n|-------------------------------------------------------|\n| `https://www.googleapis.com/auth/webmasters.readonly` |\n| `https://www.googleapis.com/auth/webmasters` |\n\n### Request body\n\nDo not supply a request body with this method.\n\nResponse\n--------\n\nIf successful, this method returns a [Sitemaps resource](/webmaster-tools/v1/sitemaps#resource) in the response body.\n\nTry it!\n-------\n\n\nUse the APIs Explorer below to call this method on live data and see the response."]]
