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

# Broken links and images

> One entry per broken URL, with the pages that link to it — the issues table holds a row per page per link. Paged by URL; `meta.total` is the number of broken URLs.



## OpenAPI

````yaml https://api.surnex.io/docs/openapi.json get /v1/projects/{projectId}/audits/{auditId}/resources
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}/audits/{auditId}/resources:
    get:
      tags:
        - audits
      summary: Broken links and images
      description: >-
        One entry per broken URL, with the pages that link to it — the issues
        table holds a row per page per link. Paged by URL; `meta.total` is the
        number of broken URLs.
      parameters:
        - schema:
            type: string
            format: uuid
          required: true
          name: projectId
          in: path
        - schema:
            type: string
            format: uuid
          required: true
          name: auditId
          in: path
        - schema:
            type: integer
            minimum: 1
            default: 1
          required: false
          name: page
          in: query
        - schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 10
          required: false
          name: per_page
          in: query
        - schema:
            type: string
            maxLength: 200
          required: false
          name: search
          in: query
      responses:
        '200':
          description: One page of broken URLs
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    enum:
                      - true
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        url:
                          type: string
                        issue_type:
                          type: string
                        severity:
                          type: string
                          enum:
                            - error
                            - warning
                            - notice
                        description:
                          type: string
                        recommendation:
                          type: string
                          nullable: true
                        found_on:
                          type: array
                          items:
                            type: string
                      required:
                        - url
                        - issue_type
                        - severity
                        - description
                        - recommendation
                        - found_on
                  meta:
                    type: object
                    properties:
                      page:
                        type: integer
                        minimum: 1
                      per_page:
                        type: integer
                        minimum: 1
                        maximum: 500
                      total:
                        type: integer
                        minimum: 0
                    required:
                      - page
                      - per_page
                      - total
                required:
                  - success
                  - data
                  - meta

````

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