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

# Reporting catalogue

> Every reporting view and its metrics — name, label, description, unit, and which way is better — for a reporting tool's metric picker. The same for every project; read once.



## OpenAPI

````yaml https://api.surnex.io/docs/openapi.json get /v1/reporting
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/reporting:
    get:
      tags:
        - reporting
      summary: Reporting catalogue
      description: >-
        Every reporting view and its metrics — name, label, description, unit,
        and which way is better — for a reporting tool's metric picker. The same
        for every project; read once.
      responses:
        '200':
          description: Views and their metrics
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    enum:
                      - true
                  data:
                    type: array
                    nullable: true
                    items:
                      type: object
                      properties:
                        view:
                          type: string
                          enum:
                            - rankings
                            - ai-overviews
                            - backlinks
                            - site-audit
                            - web-vitals
                            - ai-visibility
                            - local-seo
                            - domain
                        label:
                          type: string
                        description:
                          type: string
                        history:
                          type: boolean
                        metrics:
                          type: array
                          items:
                            type: object
                            properties:
                              key:
                                type: string
                              label:
                                type: string
                              description:
                                type: string
                              unit:
                                type: string
                                enum:
                                  - number
                                  - position
                                  - percent
                                  - score
                                  - ms
                                  - ratio
                                  - currency
                              better:
                                type: string
                                nullable: true
                                enum:
                                  - higher
                                  - lower
                                  - null
                            required:
                              - key
                              - label
                              - description
                              - unit
                              - better
                      required:
                        - view
                        - label
                        - description
                        - history
                        - metrics
                required:
                  - success
                  - data

````

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