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

# Add a page



## OpenAPI

````yaml https://api.surnex.io/docs/openapi.json post /v1/projects/{projectId}/reports/{reportId}/pages
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}/reports/{reportId}/pages:
    post:
      tags:
        - reports
      summary: Add a page
      parameters:
        - schema:
            type: string
            format: uuid
          required: true
          name: projectId
          in: path
        - schema:
            type: string
            format: uuid
          required: true
          name: reportId
          in: path
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  minLength: 1
                  maxLength: 200
                layout_columns:
                  type: integer
                  minimum: 1
                  maximum: 4
                  default: 2
              required:
                - name
      responses:
        '200':
          description: The report
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    enum:
                      - true
                  data:
                    type: object
                    nullable: true
                    properties:
                      id:
                        type: string
                        format: uuid
                      name:
                        type: string
                      description:
                        type: string
                        nullable: true
                      date_range_start:
                        type: string
                        nullable: true
                      date_range_end:
                        type: string
                        nullable: true
                      date_range_preset:
                        type: string
                        nullable: true
                      is_archived:
                        type: boolean
                      schedule_enabled:
                        type: boolean
                      pages:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                              format: uuid
                            name:
                              type: string
                            sort_order:
                              type: integer
                            layout_columns:
                              type: integer
                            widgets:
                              type: array
                              items:
                                type: object
                                properties:
                                  id:
                                    type: string
                                    format: uuid
                                  widget_type:
                                    type: string
                                    enum:
                                      - stat_card
                                      - line_chart
                                      - bar_chart
                                      - donut_chart
                                      - table
                                      - text
                                  data_source:
                                    type: string
                                    nullable: true
                                    enum:
                                      - tracking.overview
                                      - tracking.changes
                                      - tracking.history
                                      - backlinks.summary
                                      - backlinks.history
                                      - backlinks.anchors
                                      - audit.summary
                                      - audit.issues
                                      - audit.pages
                                      - geo.overview
                                      - geo.trend
                                      - geo.topics
                                      - web_vitals.latest
                                      - local.overview
                                      - domain.overview
                                      - null
                                  title:
                                    type: string
                                  config:
                                    nullable: true
                                  position_x:
                                    type: integer
                                  position_y:
                                    type: integer
                                  width:
                                    type: integer
                                  height:
                                    type: integer
                                  created_at:
                                    type: string
                                    format: date-time
                                required:
                                  - id
                                  - widget_type
                                  - data_source
                                  - title
                                  - position_x
                                  - position_y
                                  - width
                                  - height
                                  - created_at
                            created_at:
                              type: string
                              format: date-time
                          required:
                            - id
                            - name
                            - sort_order
                            - layout_columns
                            - widgets
                            - created_at
                      created_by:
                        type: string
                        nullable: true
                        format: uuid
                      created_at:
                        type: string
                        format: date-time
                      updated_at:
                        type: string
                        format: date-time
                    required:
                      - id
                      - name
                      - description
                      - date_range_start
                      - date_range_end
                      - date_range_preset
                      - is_archived
                      - schedule_enabled
                      - pages
                      - created_by
                      - created_at
                      - updated_at
                required:
                  - success
                  - data

````

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