AI-generated Key Takeaways
-
Retrieves information for a specific website using its URL.
-
Requires authorization with
webmasters.readonlyorwebmastersscope. -
Uses a
GETrequest to the/webmasters/v3/sites/siteUrlendpoint. -
Returns a
Sitesresource with details about the specified website upon success. -
The
siteUrlparameter accepts the URL or domain of the site for retrieval.
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.
Try it!
Use the APIs Explorer below to call this method on live data and see the response.