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

# A specific gap analysis



## OpenAPI

````yaml https://api.surnex.io/docs/openapi.json get /v1/projects/{projectId}/backlinks/gap/{gapId}
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}/backlinks/gap/{gapId}:
    get:
      tags:
        - backlinks
      summary: A specific gap analysis
      parameters:
        - schema:
            type: string
            format: uuid
          required: true
          name: projectId
          in: path
        - schema:
            type: string
            format: uuid
          required: true
          name: gapId
          in: path
      responses:
        '200':
          description: The analysis, without its rows
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    enum:
                      - true
                  data:
                    type: object
                    nullable: true
                    properties:
                      id:
                        type: string
                        format: uuid
                      target_domain:
                        type: string
                      competitor_domains:
                        type: array
                        items:
                          type: string
                      status:
                        type: string
                        enum:
                          - pending
                          - processing
                          - completed
                          - failed
                      error_message:
                        type: string
                        nullable: true
                      completed_at:
                        type: string
                        nullable: true
                        format: date-time
                      created_at:
                        type: string
                        format: date-time
                      result_count:
                        type: integer
                        nullable: true
                    required:
                      - id
                      - target_domain
                      - competitor_domains
                      - status
                      - error_message
                      - completed_at
                      - created_at
                      - result_count
                required:
                  - success
                  - data

````

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