Logo
Google API Documentation

webmasters.searchanalytics.query

POST {{baseUrl}}/webmasters/v3/sites/:siteUrl/searchAnalytics/query?$.xgafv=<string>&access_token=<string>&alt=<string>&callback=<string>&fields=<string>&key=<string>&oauth_token=<string>&prettyPrint=<boolean>&quotaUser=<string>&upload_protocol=<string>&uploadType=<string>

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. When 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.

 

Body PARAM

Key Datatype Required Description 
$.xgafv
string V1 error format.
access_token
string OAuth access token.
alt
string Data format for response.
callback
string JSONP
fields
string Selector specifying which fields to include in a partial response.
key
string 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.
oauth_token
string OAuth 2.0 token for the current user.
prettyPrint
Curl
curl -X POST 'https://searchconsole.googleapis.com//webmasters/v3/sites/:siteUrl/searchAnalytics/query?$.xgafv=<string>&access_token=<string>&alt=<string>&callback=<string>&fields=<string>&key=<string>&oauth_token=<string>&prettyPrint=<boolean>&quotaUser=<string>&upload_protocol=<string>&uploadType=<string>?$.xgafv=<string>&access_token=<string>&alt=<string>&callback=<string>&fields=<string>&key=<string>&oauth_token=<string>&prettyPrint=<boolean>&quotaUser=<string>&upload_protocol=<string>&uploadType=<string>' -H 'Content-Type: application/json' -d '{"aggregationType":"\u003cstring\u003e","dimensionFilterGroups":[{"filters":[{"dimension":"\u003cstring\u003e","expression":"\u003cstring\u003e","operator":"\u003cstring\u003e"},{"dimension":"\u003cstring\u003e","expression":"\u003cstring\u003e","operator":"\u003cstring\u003e"}],"groupType":"\u003cstring\u003e"},{"filters":[{"dimension":"\u003cstring\u003e","expression":"\u003cstring\u003e","operator":"\u003cstring\u003e"},{"dimension":"\u003cstring\u003e","expression":"\u003cstring\u003e","operator":"\u003cstring\u003e"}],"groupType":"\u003cstring\u003e"}],"dimensions":["\u003cstring\u003e","\u003cstring\u003e"],"endDate":"\u003cstring\u003e","rowLimit":"\u003cinteger\u003e","searchType":"\u003cstring\u003e","startDate":"\u003cstring\u003e","startRow":"\u003cinteger\u003e"}'

ENDPOINTS