Get search performance
get_search_performanceGet search performance data from Google Search Console — keywords or pages, with clicks, impressions, CTR, and average position. Use for SEO performance, keyword rankings, organic traffic, search visibility, or per-page SEO. Page SEO: pass dimensions=["page"] (optional page_filter). Keywords: dimensions=["query"] (default). Combinable: ["query","page"].
Routing: Call get_site_list first if you don't already know the site_url to query. Page SEO uses this door with dimensions=["page"] — there is no second page door.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| end_date | No | End date in YYYY-MM-DD format. Defaults to today. | |
| site_url | Yes | The site URL exactly as shown in Search Console (e.g., "sc-domain:example.com" or "https://example.com/") | |
| companyId | Yes | FreedomOS company id to act within (you must be a member). Required for company-scoped tools. | |
| row_limit | No | Max rows to return (1-100). Defaults to 25. | |
| dimensions | No | Dimensions to group by, combinable: ["query"] for keywords, ["page"] for pages, ["query","page"] for both. Defaults to ["query"]. | |
| start_date | No | Start date in YYYY-MM-DD format. Defaults to 28 days ago. | |
| page_filter | No | Optional filter: only include rows where the page URL contains this string. | |
| query_filter | No | Optional filter: only include rows where the query contains this string. |