Read Search Console performance
get_search_console_performanceReads the project's Google Search Console search analytics: clicks, impressions, CTR and average position, grouped by query, page, country, device, date or search appearance, with filters, paging and a comparison with an earlier period. Needs Search Console connected to the project. Uses no credits.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"projectId": "<projectId>"
},
"name": "get_search_console_performance"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| type | No | Which Google search to report on. Defaults to web. | |
| brand | No | 'branded' keeps only searches that name the project's brand, 'nonBranded' only those that do not, matched by a simple pattern of the saved brand names (the domain's name when none are saved). Default all. Google leaves rare searches out when filtering by search term, so branded plus nonBranded can be less than all. | |
| compare | No | Also read the period of the same length just before ('previous') or the same days a year before ('year'), and give each row its numbers there as `previous`. A row not among the first 1,000 rows of that period has previous null. One more Search Console read. | |
| endDate | No | Last day, YYYY-MM-DD in Pacific Time. Give it with startDate. | |
| filters | No | Up to 5 filters, all of which a row must match. | |
| rowLimit | No | Rows to return, at most 1000. Defaults to 1000. Page through more with startRow. | |
| startRow | No | Rows to skip, for paging. Defaults to 0. | |
| dataState | No | 'all' includes the newest, still changing days; 'final' only settled data. Defaults to all. | |
| dateRange | No | A date window ending at the latest data. Defaults to last_28_days. Ignored when startDate and endDate are given. | |
| projectId | Yes | Required. The Visibility Genies project this call works in and is billed to. Call list_projects to find one. | |
| startDate | No | First day, YYYY-MM-DD in Pacific Time. Give it with endDate. | |
| dimensions | No | What to group rows by, 1-4 of the options. Defaults to ["query"]. searchAppearance cannot be combined with another dimension. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| ok | Yes | ||
| meta | No | ||
| rows | No | ||
| reason | No | ||
| endDate | No | ||
| hasMore | No | ||
| siteUrl | No | ||
| compared | No | ||
| rowCount | No | ||
| connected | No | ||
| startDate | No | ||
| connectUrl | No | ||
| dimensions | No | ||
| nextStartRow | No |