"description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
"description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.",
"description":"Query your data with filters and parameters that you define. Returns zero or more rows grouped by the row keys that you define. You must define a date range of one or more days.\n\nWhen date is one of the group by values, any days without data are omitted from the result list. If you need to know which days have data, issue a broad date range query grouped by date for any metric, and see which day rows are returned.",
"httpMethod":"POST",
"id":"webmasters.searchanalytics.query",
"parameterOrder":[
"siteUrl"
],
"parameters":{
"siteUrl":{
"description":"The site's URL, including protocol. For example: http://www.example.com/",
"description":"Lists the sitemaps-entries submitted for this site, or included in the sitemap index file (if sitemapIndex is specified in the request).",
"httpMethod":"GET",
"id":"webmasters.sitemaps.list",
"parameterOrder":[
"siteUrl"
],
"parameters":{
"siteUrl":{
"description":"The site's URL, including protocol. For example: http://www.example.com/",
"location":"path",
"required":true,
"type":"string"
},
"sitemapIndex":{
"description":"A URL of a site's sitemap index. For example: http://www.example.com/sitemapindex.xml",
"description":"Adds a site to the set of the user's sites in Search Console.",
"httpMethod":"PUT",
"id":"webmasters.sites.add",
"parameterOrder":[
"siteUrl"
],
"parameters":{
"siteUrl":{
"description":"The URL of the site to add.",
"location":"path",
"required":true,
"type":"string"
}
},
"path":"sites/{siteUrl}",
"scopes":[
"https://www.googleapis.com/auth/webmasters"
]
},
"delete":{
"description":"Removes a site from the set of the user's Search Console sites.",
"httpMethod":"DELETE",
"id":"webmasters.sites.delete",
"parameterOrder":[
"siteUrl"
],
"parameters":{
"siteUrl":{
"description":"The URI of the property as defined in Search Console. Examples: http://www.example.com/ or android-app://com.example/ Note: for property-sets, use the URI that starts with sc-set: which is used in Search Console URLs.",
"location":"path",
"required":true,
"type":"string"
}
},
"path":"sites/{siteUrl}",
"scopes":[
"https://www.googleapis.com/auth/webmasters"
]
},
"get":{
"description":"Retrieves information about specific site.",
"httpMethod":"GET",
"id":"webmasters.sites.get",
"parameterOrder":[
"siteUrl"
],
"parameters":{
"siteUrl":{
"description":"The URI of the property as defined in Search Console. Examples: http://www.example.com/ or android-app://com.example/ Note: for property-sets, use the URI that starts with sc-set: which is used in Search Console URLs.",
"description":"Retrieves details about crawl errors for a site's sample URL.",
"httpMethod":"GET",
"id":"webmasters.urlcrawlerrorssamples.get",
"parameterOrder":[
"siteUrl",
"url",
"category",
"platform"
],
"parameters":{
"category":{
"description":"The crawl error category. For example: authPermissions",
"enum":[
"authPermissions",
"flashContent",
"manyToOneRedirect",
"notFollowed",
"notFound",
"other",
"roboted",
"serverError",
"soft404"
],
"enumDescriptions":[
"",
"",
"",
"",
"",
"",
"",
"",
""
],
"location":"query",
"required":true,
"type":"string"
},
"platform":{
"description":"The user agent type (platform) that made the request. For example: web",
"enum":[
"mobile",
"smartphoneOnly",
"web"
],
"enumDescriptions":[
"",
"",
""
],
"location":"query",
"required":true,
"type":"string"
},
"siteUrl":{
"description":"The site's URL, including protocol. For example: http://www.example.com/",
"location":"path",
"required":true,
"type":"string"
},
"url":{
"description":"The relative path (without the site) of the sample URL. It must be one of the URLs returned by list(). For example, for the URL https://www.example.com/pagename on the site https://www.example.com/, the url value is pagename",
"description":"The crawl error category. For example: authPermissions",
"enum":[
"authPermissions",
"flashContent",
"manyToOneRedirect",
"notFollowed",
"notFound",
"other",
"roboted",
"serverError",
"soft404"
],
"enumDescriptions":[
"",
"",
"",
"",
"",
"",
"",
"",
""
],
"location":"query",
"required":true,
"type":"string"
},
"platform":{
"description":"The user agent type (platform) that made the request. For example: web",
"enum":[
"mobile",
"smartphoneOnly",
"web"
],
"enumDescriptions":[
"",
"",
""
],
"location":"query",
"required":true,
"type":"string"
},
"siteUrl":{
"description":"The site's URL, including protocol. For example: http://www.example.com/",
"location":"path",
"required":true,
"type":"string"
},
"url":{
"description":"The relative path (without the site) of the sample URL. It must be one of the URLs returned by list(). For example, for the URL https://www.example.com/pagename on the site https://www.example.com/, the url value is pagename",
"description":"[Optional; Default is \"auto\"] How data is aggregated. If aggregated by property, all data for the same property is aggregated; if aggregated by page, all data is aggregated by canonical URI. If you filter or group by page, choose AUTO; otherwise you can aggregate either by property or by page, depending on how you want your data calculated; see the help documentation to learn how data is calculated differently by site versus by page.\n\nNote: If you group or filter by page, you cannot aggregate by property.\n\nIf you specify any value other than AUTO, the aggregation type in the result will match the requested type, or if you request an invalid type, you will get an error. The API will never change your aggregation type if the requested type is invalid.",
"type":"string"
},
"dimensionFilterGroups":{
"description":"[Optional] Zero or more filters to apply to the dimension grouping values; for example, 'query contains \"buy\"' to see only data where the query string contains the substring \"buy\" (not case-sensitive). You can filter by a dimension without grouping by it.",
"items":{
"$ref":"ApiDimensionFilterGroup"
},
"type":"array"
},
"dimensions":{
"description":"[Optional] Zero or more dimensions to group results by. Dimensions are the group-by values in the Search Analytics page. Dimensions are combined to create a unique row key for each row. Results are grouped in the order that you supply these dimensions.",
"items":{
"type":"string"
},
"type":"array"
},
"endDate":{
"description":"[Required] End date of the requested date range, in YYYY-MM-DD format, in PST (UTC - 8:00). Must be greater than or equal to the start date. This value is included in the range.",
"type":"string"
},
"rowLimit":{
"description":"[Optional; Default is 1000] The maximum number of rows to return. Must be a number from 1 to 5,000 (inclusive).",
"format":"int32",
"type":"integer"
},
"searchType":{
"description":"[Optional; Default is \"web\"] The search type to filter for.",
"type":"string"
},
"startDate":{
"description":"[Required] Start date of the requested date range, in YYYY-MM-DD format, in PST time (UTC - 8:00). Must be less than or equal to the end date. This value is included in the range.",
"type":"string"
},
"startRow":{
"description":"[Optional; Default is 0] Zero-based index of the first row in the response. Must be a non-negative number.",
"description":"A list of rows, one per result, grouped by key. Metrics in each row are aggregated for all data grouped by that key either by page or property, as specified by the aggregation type parameter.",
"id":"SearchAnalyticsQueryResponse",
"properties":{
"responseAggregationType":{
"description":"How the results were aggregated.",
"type":"string"
},
"rows":{
"description":"A list of rows grouped by the key values in the order given in the query.",
