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

# Get GSC performance report

> Returns Google Search Console performance report with clicks, impressions, CTR, positions, top queries, top pages, movers, opportunities, and article suggestions. Returns connect URL if GSC is not linked. Free (0 credits).



## OpenAPI

````yaml get /api/agent/gsc/report
openapi: 3.1.0
info:
  title: Citedy Agent API
  version: 1.0.0
  description: >-
    Public contract for Citedy agent integrations. This contract reflects the
    current /api/agent surface without changing runtime behavior.
  contact:
    name: Citedy Support
    url: https://www.citedy.com
  license:
    name: Proprietary
    url: https://www.citedy.com
servers:
  - url: https://www.citedy.com
security: []
tags:
  - name: Health
    description: Platform and dependency health
  - name: Registration
    description: Agent onboarding and approval
  - name: Agent
    description: Agent identity and key lifecycle
  - name: Scout
    description: Trend scouting endpoints
  - name: Gaps
    description: Content gap analysis
  - name: Autopilot
    description: Article generation and retrieval
  - name: Articles
    description: Queued article generation job polling
  - name: Adaptations
    description: Social adaptation generation
  - name: Sessions
    description: Autopilot recurring sessions
  - name: Lead Magnets
    description: Lead magnet generation and state
  - name: Warm Leads
    description: Warm-lead report generation and export
  - name: Ingest
    description: Content ingestion jobs
  - name: Competitors
    description: Competitor discovery and analysis
  - name: Personas
    description: Writing persona catalog
  - name: Webhooks
    description: Webhook endpoint registration and delivery logs
  - name: Publishing
    description: Social publishing, scheduling and cancellation
  - name: Schedule
    description: Content schedule timeline and gap analysis
  - name: Settings
    description: Agent preferences and configuration
  - name: Scan
    description: Experimental trend scanning (xAI Grok)
  - name: Status
    description: Operational readiness and actionable onboarding status
  - name: Products
    description: Product knowledge base document management
  - name: Shorts
    description: Short-form video generation and polling
  - name: SEO Tools
    description: Agent-authenticated SEO diagnostics tools exposed via MCP seo.* namespace.
  - name: GSC
    description: Google Search Console integration and reporting
paths:
  /api/agent/gsc/report:
    get:
      tags:
        - GSC
      summary: Get GSC performance report
      description: >-
        Returns Google Search Console performance report with clicks,
        impressions, CTR, positions, top queries, top pages, movers,
        opportunities, and article suggestions. Returns connect URL if GSC is
        not linked. Free (0 credits).
      operationId: getGscReport
      parameters:
        - name: force_refresh
          in: query
          required: false
          schema:
            type: boolean
          description: Force fresh GSC data fetch instead of cached morning report
      responses:
        '200':
          description: GSC report (connected) or connect URL (not connected)
          content:
            application/json:
              schema:
                oneOf:
                  - type: object
                    properties:
                      connected:
                        type: boolean
                        enum:
                          - true
                      cached:
                        type: boolean
                      reportDate:
                        type: string
                        format: date
                      gscProperty:
                        type: string
                      rangeDays:
                        type: integer
                      summary:
                        type: object
                        properties:
                          clicks:
                            type: integer
                          impressions:
                            type: integer
                          ctr:
                            type: number
                          position:
                            type: number
                          clicksChangePct:
                            type:
                              - number
                              - 'null'
                          impressionsChangePct:
                            type:
                              - number
                              - 'null'
                      topQueries:
                        type: array
                        items:
                          type: object
                          properties:
                            query:
                              type: string
                            clicks:
                              type: integer
                            impressions:
                              type: integer
                            ctr:
                              type: number
                            position:
                              type: number
                      topPages:
                        type: array
                        items:
                          type: object
                          properties:
                            page:
                              type: string
                            clicks:
                              type: integer
                            impressions:
                              type: integer
                            ctr:
                              type: number
                            position:
                              type: number
                      movers:
                        type: object
                        properties:
                          gainers:
                            type: array
                            items:
                              type: object
                          losers:
                            type: array
                            items:
                              type: object
                      opportunities:
                        type: array
                        items:
                          type: object
                      articleSuggestions:
                        type: array
                        items:
                          type: object
                          properties:
                            keyword:
                              type: string
                            reason:
                              type: string
                            impressions:
                              type: integer
                            position:
                              type: number
                            opportunityScore:
                              type: number
                            workflow:
                              type: string
                    required:
                      - connected
                      - reportDate
                      - summary
                  - type: object
                    properties:
                      connected:
                        type: boolean
                        enum:
                          - false
                      connect_url:
                        type: string
                        format: uri
                      message:
                        type: string
                    required:
                      - connected
                      - connect_url
                      - message
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/InternalError'
      security:
        - AgentApiKey: []
components:
  responses:
    Unauthorized:
      description: Unauthorized
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    Forbidden:
      description: Forbidden
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    TooManyRequests:
      description: Rate limit exceeded
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/RateLimitErrorResponse'
    InternalError:
      description: Internal server error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  schemas:
    ErrorResponse:
      type: object
      properties:
        error:
          type: string
        message:
          type: string
      required:
        - error
      additionalProperties: true
    RateLimitErrorResponse:
      allOf:
        - $ref: '#/components/schemas/ErrorResponse'
        - type: object
          properties:
            retry_after:
              type: integer
          required:
            - retry_after
  securitySchemes:
    AgentApiKey:
      type: http
      scheme: bearer
      description: Bearer citedy_agent_* key

````