> ## Documentation Index
> Fetch the complete documentation index at: https://promptwatch.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Google Search Insights pages

> Google Search Console clicks, impressions, and position per site pathname, with previous-period change. Paginated (default page 1, size 50, max 100).



## OpenAPI

````yaml /v2/openapi.json get /search-insights/google/pages
openapi: 3.0.0
info:
  title: Promptwatch API v2
  description: >-
    API v2 for customer integrations with Promptwatch monitoring platform. This
    version provides improved structure, additional endpoints, and enhanced
    functionality.
  version: 2.0.0
  contact:
    name: Promptwatch Support
    email: team@promptwatch.com
    url: https://promptwatch.com
  license:
    name: Commercial
    url: https://promptwatch.com/terms-and-conditions
servers:
  - url: https://server.promptwatch.com/api/v2
    description: Promptwatch API v2
security: []
tags:
  - name: Authentication
    description: API key validation and authentication
  - name: Content
    description: >-
      AI content generation and optimization. Create content asynchronously and
      poll for results.
  - name: Content Agent
    description: >-
      Content Agent (automated content) lifecycle: project settings, scheduled
      slots, review (accept/decline), and publish.
  - name: Content Gap
    description: Content gap analysis and recommendations
  - name: Publishing
    description: >-
      Publish content to a connected CMS, or record a live URL, and track the
      published page
  - name: Models
    description: Available LLM models
  - name: Monitors
    description: Monitor management and CRUD operations
  - name: Page Tracker
    description: Track URLs and inspect citation stats, responses, and prompts
  - name: Prompts
    description: Prompt management and operations
  - name: Query Fanouts
    description: ChatGPT query fanout keywords
  - name: Responses
    description: LLM response data and analytics
  - name: Tags
    description: Tag management for prompts
  - name: Topics
    description: Topic management for prompts
  - name: Actions
    description: Action items (GEO suggestions and tasks)
  - name: Personas
    description: Persona configuration for monitors
  - name: Brands
    description: Brand management for competitive analysis
  - name: Visibility
    description: Brand visibility time series and competitor heatmaps
  - name: Events
    description: >-
      Dated project events such as prompts added and actions completed, for
      annotating time series
  - name: Citations
    description: Citation analytics from AI responses
  - name: Analytics
    description: Visitor analytics, AI crawler logs, sentiment, and brand visibility trends
  - name: Search Insights
    description: >-
      Google Search Console and Bing Webmaster performance for the project
      website
  - name: Projects
    description: Project management (organization-level keys only)
  - name: Usage
    description: Plan usage and limits (organization-level keys only)
  - name: Sitemap
    description: Sitemap feeds, crawler settings, crawl progress, and discovered URLs
  - name: Site Health
    description: >-
      Crawled pages with SEO issues (titles, meta descriptions, H1, thin
      content)
  - name: Socials
    description: >-
      Social media citations (Reddit posts, YouTube videos, and LinkedIn posts)
      found in LLM responses
  - name: Ads Radar
    description: Sponsored ads captured in AI answers
  - name: Shopping
    description: Product appearances in AI shopping answers and tracked products
paths:
  /search-insights/google/pages:
    get:
      tags:
        - Search Insights
      summary: Google Search Insights pages
      description: >-
        Google Search Console clicks, impressions, and position per site
        pathname, with previous-period change. Paginated (default page 1, size
        50, max 100).
      operationId: getGoogleSearchInsightsPages
      parameters:
        - schema:
            type: string
            enum:
              - 7d
              - 30d
          in: query
          name: period
          required: true
          description: >-
            Window to compare: 7d is the last 7 complete days, 30d is the last
            30
        - schema:
            type: integer
            default: 1
            minimum: 1
          in: query
          name: page
          required: false
          description: Page number (1-based)
        - schema:
            type: integer
            default: 50
            minimum: 1
            maximum: 100
          in: query
          name: size
          required: false
          description: Page size
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    - pathname: /pricing
                      clicks: 40
                      impressions: 800
                      position: 6.1
                      clicksChange: 5
                      impressionsChange: 10
                      previousClicks: 38
                      previousImpressions: 720
                  total: 1
                  page: 1
                  size: 50
                  totalPages: 1
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        pathname:
                          type: string
                          description: Site pathname
                        clicks:
                          type: number
                          description: Clicks in the current period
                        impressions:
                          type: number
                          description: Impressions in the current period
                        position:
                          type: number
                          nullable: true
                          description: Impression-weighted average position
                        clicksChange:
                          type: number
                          nullable: true
                          description: Percent change in clicks vs the previous period
                        impressionsChange:
                          type: number
                          nullable: true
                          description: Percent change in impressions vs the previous period
                        previousClicks:
                          type: number
                          description: Clicks in the previous period
                        previousImpressions:
                          type: number
                          description: Impressions in the previous period
                      required:
                        - pathname
                        - clicks
                        - impressions
                        - position
                        - clicksChange
                        - impressionsChange
                        - previousClicks
                        - previousImpressions
                      additionalProperties: false
                    description: Pathnames for the requested page
                  total:
                    type: integer
                    description: Pathnames with activity in the current or previous period
                  page:
                    type: integer
                    description: Page number (1-based)
                  size:
                    type: integer
                    description: Page size
                  totalPages:
                    type: integer
                    description: Total pages for this page size
                required:
                  - data
                  - total
                  - page
                  - size
                  - totalPages
                additionalProperties: false
        '400':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                example:
                  error: Bad Request
                  code: DATE_RANGE_TOO_LARGE
                  message: Date range cannot exceed 90 days
                properties:
                  error:
                    type: string
                    description: Error label
                  code:
                    type: string
                    description: Optional machine-readable code (e.g. DATE_RANGE_TOO_LARGE)
                  message:
                    type: string
                    description: Reason the request was rejected
                required:
                  - error
                  - message
        '401':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                example:
                  error: Unauthorized
                  message: Missing or invalid X-API-Key header.
                properties:
                  error:
                    type: string
                    description: Error category (often aligned with HTTP semantics)
                  code:
                    type: string
                    description: Optional machine-readable code
                  message:
                    type: string
                    description: Human-readable explanation
                  details:
                    type: object
                    description: Optional structured detail (e.g. validation)
                    additionalProperties: true
                required:
                  - error
                  - message
                additionalProperties: false
        '403':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                example:
                  code: GOOGLE_SEARCH_CONSOLE_NOT_CONNECTED
                  message: Google Search Console is not connected for this project
                properties:
                  code:
                    type: string
                    description: Error code indicating the type of error
                    enum:
                      - GOOGLE_SEARCH_CONSOLE_NOT_CONNECTED
                      - GOOGLE_SEARCH_CONSOLE_SITE_URL_NOT_CONFIGURED
                      - GOOGLE_SEARCH_CONSOLE_QUOTA_EXCEEDED
                      - GOOGLE_SEARCH_CONSOLE_ACCESS_FORBIDDEN
                      - GOOGLE_SEARCH_CONSOLE_TOKEN_REFRESH_FAILED
                      - BING_WEBMASTER_SITE_URL_NOT_CONFIGURED
                      - BING_WEBMASTER_QUOTA_EXCEEDED
                      - BING_WEBMASTER_ACCESS_FORBIDDEN
                      - BING_WEBMASTER_TOKEN_REFRESH_FAILED
                      - BING_WEBMASTER_API_FAILED
                      - INTERNAL_ERROR
                  message:
                    type: string
                    description: Human-readable error message
                required:
                  - code
                  - message
                additionalProperties: false
        '429':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                example:
                  code: GOOGLE_SEARCH_CONSOLE_NOT_CONNECTED
                  message: Google Search Console is not connected for this project
                properties:
                  code:
                    type: string
                    description: Error code indicating the type of error
                    enum:
                      - GOOGLE_SEARCH_CONSOLE_NOT_CONNECTED
                      - GOOGLE_SEARCH_CONSOLE_SITE_URL_NOT_CONFIGURED
                      - GOOGLE_SEARCH_CONSOLE_QUOTA_EXCEEDED
                      - GOOGLE_SEARCH_CONSOLE_ACCESS_FORBIDDEN
                      - GOOGLE_SEARCH_CONSOLE_TOKEN_REFRESH_FAILED
                      - BING_WEBMASTER_SITE_URL_NOT_CONFIGURED
                      - BING_WEBMASTER_QUOTA_EXCEEDED
                      - BING_WEBMASTER_ACCESS_FORBIDDEN
                      - BING_WEBMASTER_TOKEN_REFRESH_FAILED
                      - BING_WEBMASTER_API_FAILED
                      - INTERNAL_ERROR
                  message:
                    type: string
                    description: Human-readable error message
                required:
                  - code
                  - message
                additionalProperties: false
        '500':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                example:
                  code: GOOGLE_SEARCH_CONSOLE_NOT_CONNECTED
                  message: Google Search Console is not connected for this project
                properties:
                  code:
                    type: string
                    description: Error code indicating the type of error
                    enum:
                      - GOOGLE_SEARCH_CONSOLE_NOT_CONNECTED
                      - GOOGLE_SEARCH_CONSOLE_SITE_URL_NOT_CONFIGURED
                      - GOOGLE_SEARCH_CONSOLE_QUOTA_EXCEEDED
                      - GOOGLE_SEARCH_CONSOLE_ACCESS_FORBIDDEN
                      - GOOGLE_SEARCH_CONSOLE_TOKEN_REFRESH_FAILED
                      - BING_WEBMASTER_SITE_URL_NOT_CONFIGURED
                      - BING_WEBMASTER_QUOTA_EXCEEDED
                      - BING_WEBMASTER_ACCESS_FORBIDDEN
                      - BING_WEBMASTER_TOKEN_REFRESH_FAILED
                      - BING_WEBMASTER_API_FAILED
                      - INTERNAL_ERROR
                  message:
                    type: string
                    description: Human-readable error message
                required:
                  - code
                  - message
                additionalProperties: false
      security:
        - ApiKeyAuth: []
components:
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: >-
        API key for authentication. Get yours from the Promptwatch dashboard
        under Settings > API Keys.

````