Sites: get
Requires authorization
Retrieves information about specific site.
Try it now.
Request
HTTP request
GET https://www.googleapis.com/webmasters/v3/sites/siteUrl
Parameters
| Parameter name |
Value |
Description |
| Path parameters |
siteUrl |
string |
The URL of the property to retrieve, as defined by Search Console. Examples:
http://www.example.com/ (for a URL-prefix property) or
sc-domain:example.com (for a Domain property)
|
Authorization
This request requires authorization with at least one of the following scopes (read more about authentication and authorization).
| Scope |
|---|
https://www.googleapis.com/auth/webmasters.readonly |
https://www.googleapis.com/auth/webmasters |
Request body
Do not supply a request body with this method.
Response
If successful, this method returns a Sites resource in the response body.
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.
[null,null,["Last updated 2024-07-23 UTC."],[[["Retrieves information for a specific website using its URL."],["Requires authorization with `webmasters.readonly` or `webmasters` scope."],["Uses a `GET` request to the `/webmasters/v3/sites/siteUrl` endpoint."],["Returns a `Sites` resource with details about the specified website upon success."],["The `siteUrl` parameter accepts the URL or domain of the site for retrieval."]]],["This resource allows retrieving information about a specific site using its URL. The request is a `GET` method to the specified endpoint, requiring the `siteUrl` as a path parameter. The `siteUrl` can be either a URL-prefix (e.g., `http://www.example.com/`) or a domain property (e.g., `sc-domain:example.com`). Authorization is necessary, using either `webmasters.readonly` or `webmasters` scopes. No request body is needed; a successful response returns a `Sites` resource.\n"]]
