> ## 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 summary

> `in_map_pack` counts centre positions 1–3 — what appears without expanding the map. `grid_top3_share` is the share of every keyword's newest grid in the top 3.



## OpenAPI

````yaml https://api.surnex.io/docs/openapi.json get /v1/projects/{projectId}/local/overview
openapi: 3.1.0
info:
  title: Surnex API
  version: 1.0.0
  description: >-
    The SEO platform's API.


    **The API is the product.** The dashboard is one client and the MCP server
    at `/mcp` is another. If a number needs deriving, a service derives it —
    never a React component, or the two clients drift.


    **Two kinds of auth.** The dashboard sends a Supabase access token as a
    Bearer JWT. MCP agents send `X-API-Key`, and the organization is resolved
    from the key.


    **Two data modes.** SERP results and Google Trends are fetched live on
    request. Everything else is written by the worker and read from Postgres, so
    a freshly-created project returns empty until its jobs complete.
servers:
  - url: https://api.surnex.io
    description: Surnex API
security: []
paths:
  /v1/projects/{projectId}/local/overview:
    get:
      tags:
        - local-seo
      summary: Local summary
      description: >-
        `in_map_pack` counts centre positions 1–3 — what appears without
        expanding the map. `grid_top3_share` is the share of every keyword's
        newest grid in the top 3.
      parameters:
        - schema:
            type: string
            format: uuid
          required: true
          name: projectId
          in: path
      responses:
        '200':
          description: Summary
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    enum:
                      - true
                  data:
                    type: object
                    nullable: true
                    properties:
                      total_places:
                        type: integer
                      total_keywords:
                        type: integer
                      active_keywords:
                        type: integer
                      ranked_keywords:
                        type: integer
                      in_map_pack:
                        type: integer
                      in_top_10:
                        type: integer
                      average_position:
                        type: number
                        nullable: true
                      grid_top3_share:
                        type: number
                        nullable: true
                      grid_average_position:
                        type: number
                        nullable: true
                      average_rating:
                        type: number
                        nullable: true
                      total_reviews:
                        type: integer
                      last_checked_at:
                        type: string
                        nullable: true
                        format: date-time
                      trend:
                        type: array
                        items:
                          type: object
                          properties:
                            date:
                              type: string
                              format: date
                            average_position:
                              type: number
                            keywords:
                              type: integer
                          required:
                            - date
                            - average_position
                            - keywords
                    required:
                      - total_places
                      - total_keywords
                      - active_keywords
                      - ranked_keywords
                      - in_map_pack
                      - in_top_10
                      - average_position
                      - grid_top3_share
                      - grid_average_position
                      - average_rating
                      - total_reviews
                      - last_checked_at
                      - trend
                required:
                  - success
                  - data

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.