Search Analytics
Stay organized with collections
Save and categorize content based on your preferences.
For a list of methods for this resource, see the end of this page.
Resource representations
There is no persistent data associated with this resource.
Methods
- query
Query your search traffic data with filters and parameters that you define. The method returns zero or more rows grouped by the row keys (dimensions) that you define. You must define a date range of one or more days.
When date is one of the dimensions, any days without data are omitted from the result list. To learn which days have data, issue a query without filters grouped by date, for the date range of interest.
Results are sorted by click count descending. If two rows have the same click count, they are sorted in an arbitrary way.
See the python sample for calling this method.
The API is bounded by internal limitations of Search Console and does not guarantee to return all
data rows but rather top ones.
See limits to the amount of data available.
JSON POST Example:
POST https://www.googleapis.com/webmasters/v3/sites/https%3A%2F%2Fwww.example.com%2F/searchAnalytics/query?key={MY_API_KEY}
{
"startDate": "2015-04-01",
"endDate": "2015-05-01",
"dimensions": ["country","device"]
}
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."],[[["\u003cp\u003eThe Search Analytics API allows you to query your website's search traffic data with custom filters and parameters, returning results grouped by specified dimensions.\u003c/p\u003e\n"],["\u003cp\u003eYou can define date ranges for your queries, but the API might not return all data rows due to internal limitations, prioritizing top results instead.\u003c/p\u003e\n"],["\u003cp\u003eResults are sorted by click count in descending order, with arbitrary sorting for rows with identical click counts, and days without data are omitted from the result list.\u003c/p\u003e\n"],["\u003cp\u003eWhen querying with "date" as a dimension, you can identify days with data by performing a filter-less query grouped by date for the desired date range.\u003c/p\u003e\n"],["\u003cp\u003eThe API offers a "query" method to retrieve search traffic data and provides a Python sample for utilizing this method.\u003c/p\u003e\n"]]],["The core content details querying search traffic data using the `query` method. This method retrieves data rows grouped by defined dimensions, such as date, country, or device, within a specified date range. Results are sorted by click count in descending order. The API may not return all data rows and it's limited by Search Console's capabilities. It includes a JSON POST example for specifying start and end dates and dimensions. There is no persistent data.\n"],null,["# Search Analytics\n\n\u003cbr /\u003e\n\nFor a list of [methods](#methods) for this resource, see the end of this page.\n\nResource representations\n------------------------\n\nThere is no persistent data associated with this resource.\n\nMethods\n-------\n\n[query](/webmaster-tools/v1/searchanalytics/query)\n\n: Query your search traffic data with filters and parameters that you define. The method returns zero or more rows grouped by the row keys (dimensions) that you define. You must define a date range of one or more days.\n\n When date is one of the dimensions, any days without data are omitted from the result list. To learn which days have data, issue a query without filters grouped by date, for the date range of interest.\n\n Results are sorted by click count descending. If two rows have the same click count, they are sorted in an arbitrary way.\n\n See the [python sample](/webmaster-tools/v1/how-tos/search_analytics) for calling this method.\n\n The API is bounded by internal limitations of Search Console and does not guarantee to return all\n data rows but rather top ones.\n\n [See limits to the amount of data available](/webmaster-tools/v1/how-tos/all-your-data#data_limits). \n **JSON POST Example:** \n\n ```\n POST https://www.googleapis.com/webmasters/v3/sites/https%3A%2F%2Fwww.example.com%2F/searchAnalytics/query?key={MY_API_KEY}\n {\n \"startDate\": \"2015-04-01\",\n \"endDate\": \"2015-05-01\",\n \"dimensions\": [\"country\",\"device\"]\n }\n ```"]]
