/sites/{siteUrl}/searchAnalytics/query

POST

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.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://searchconsole.googleapis.com//sites//searchAnalytics/query' \
--header 'Content-Type: application/json' \
--data-raw '{
    "aggregationType": "AUTO",
    "dataState": "DATA_STATE_UNSPECIFIED",
    "dimensionFilterGroups": [
        {
            "filters": [
                {
                    "dimension": "QUERY",
                    "expression": "string",
                    "operator": "EQUALS"
                }
            ],
            "groupType": "AND"
        }
    ],
    "dimensions": [
        "DATE"
    ],
    "endDate": "string",
    "rowLimit": 0,
    "searchType": "WEB",
    "startDate": "string",
    "startRow": 0,
    "type": "WEB"
}'

Response Example

{
    "responseAggregationType": "AUTO",
    "rows": [
        {
            "clicks": 0,
            "ctr": 0,
            "impressions": 0,
            "keys": [
                "string"
            ],
            "position": 0
        }
    ]
}

Request

Path Params

Body Params application/json

Examples

Responses

🟢200Successful response

application/json

Body

Modified at 2022-09-12 11:46:11

/webmasters/v3/sites/{siteUrl}/searchAnalytics/query

/webmasters/v3/sites/{siteUrl}/sitemaps