Google Search Console · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Google Search Console Search Analytics API

2 actions 2 updates phrasing extends openapi/google-search-console-search-analytics-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Google Search Console's API. It is a proposal applied on top of the contract, not a document Google Search Console publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 2

$.info

$.paths['/webmasters/v3/sites/{siteUrl}/searchAnalytics/query'].post

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Google Search Console Search Analytics API
  version: 1.0.0
extends: openapi/google-search-console-search-analytics-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 1
- target: $.paths['/webmasters/v3/sites/{siteUrl}/searchAnalytics/query'].post
  update:
    x-apievangelist-phrasing:
      intent: Query search traffic clicks and impressions
      effect: read
      questions:
      - Which search queries brought the most clicks to my site last month?
      - Can I break down impressions by page, country or device for a date range?
      - What's the maximum number of rows a search performance query can return?
      - Is it possible to include fresh, not-yet-finalized data in my search traffic report?
      instructions:
      - text: Get search traffic for {siteUrl} from {startDate} to {endDate}.
        slots:
          siteUrl: path.siteUrl
          startDate: requestBody.startDate
          endDate: requestBody.endDate
      - text: Break down clicks and impressions for {siteUrl} by {dimensions} between {startDate} and {endDate}.
        slots:
          siteUrl: path.siteUrl
          dimensions: requestBody.dimensions
          startDate: requestBody.startDate
          endDate: requestBody.endDate
      - text: Pull the top {rowLimit} rows of {type} search performance for {siteUrl} from {startDate} to {endDate}.
        slots:
          rowLimit: requestBody.rowLimit
          type: requestBody.type
          siteUrl: path.siteUrl
          startDate: requestBody.startDate
          endDate: requestBody.endDate
      method: generated
      generated: '2026-10-01'