List search appearances
list_search_appearancesList a site's search appearances, including rich results and features like VIDEO or REVIEW_SNIPPET, with clicks and impressions. Use returned names for deeper breakdown.
Instructions
Step one: list the search appearances (rich results and other result features, such as VIDEO or REVIEW_SNIPPET) the property had, with clicks and impressions. Then call query_search_appearance with one of the names to break it down.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| end_date | No | Last day (inclusive), YYYY-MM-DD in Pacific Time. Defaults to today. | |
| site_url | Yes | The property, as listed by list_sites: 'sc-domain:example.com' for a domain property or 'https://www.example.com/' for a URL-prefix property. A bare domain such as 'example.com', or any URL on the site, is resolved to the property that contains it. | |
| data_state | No | 'all' includes fresh data that may still change and matches the Search Console UI; 'final' is finalized data only (lags 2-3 days). | all |
| start_date | No | First day, YYYY-MM-DD in Pacific Time. Defaults to 28 days ago. | |
| search_type | No | web |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| rows | Yes | One object per row: dimension values by name, then clicks, impressions, ctr (0-1) and position (absent for Discover and Google News). | |
| notes | No | ||
| request | Yes | The exact request body sent to Google. | |
| end_date | Yes | ||
| site_url | Yes | ||
| row_count | Yes | ||
| data_state | Yes | ||
| dimensions | Yes | ||
| start_date | Yes | ||
| search_type | Yes | ||
| next_start_row | No | Pass as start_row to fetch the next page, if there is one. | |
| aggregation_type | No | ||
| first_incomplete_date | No | ||
| first_incomplete_hour | No |