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

# Local SEO overview

> Return aggregate local SEO metrics: total keywords tracked, keywords with own-domain rankings, average position, top-3 and top-10 counts.



## OpenAPI

````yaml https://api.surnex.io/openapi.json get /v1/projects/{project_id}/local/overview
openapi: 3.1.0
info:
  title: Surnex API
  description: |-
    Surnex SEO Platform API — api.surnex.io

    Provides the complete backend for the Surnex SEO dashboard including:
    - Multi-tenant organization management
    - Project tracking (domains)
    - Keyword rank tracking (Phase 1+)
    - Backlink analysis (Phase 3+)
    - Site auditing (Phase 4+)
    - Stripe billing integration
    - MCP endpoint for AI agents at /mcp
  version: 0.1.0
servers: []
security: []
paths:
  /v1/projects/{project_id}/local/overview:
    get:
      tags:
        - Local SEO
      summary: Local SEO overview
      description: >-
        Return aggregate local SEO metrics: total keywords tracked, keywords
        with own-domain rankings, average position, top-3 and top-10 counts.
      operationId: get_local_overview_v1_projects__project_id__local_overview_get
      parameters:
        - name: project_id
          in: path
          required: true
          schema:
            type: string
            format: uuid
            title: Project Id
        - name: X-API-Key
          in: header
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: X-Api-Key
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIResponse_LocalOverviewResponse_'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - HTTPBearer: []
components:
  schemas:
    APIResponse_LocalOverviewResponse_:
      properties:
        success:
          type: boolean
          title: Success
          default: true
        data:
          anyOf:
            - $ref: '#/components/schemas/LocalOverviewResponse'
            - type: 'null'
      type: object
      title: APIResponse[LocalOverviewResponse]
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    LocalOverviewResponse:
      properties:
        total_keywords:
          type: integer
          title: Total Keywords
          default: 0
        keywords_with_rankings:
          type: integer
          title: Keywords With Rankings
          default: 0
        avg_position:
          anyOf:
            - type: number
            - type: 'null'
          title: Avg Position
        top_3_count:
          type: integer
          title: Top 3 Count
          default: 0
        top_10_count:
          type: integer
          title: Top 10 Count
          default: 0
      type: object
      title: LocalOverviewResponse
      description: Aggregate local SEO performance metrics for a project.
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer

````