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

# List reports

> List all reports for a project, ordered by most recently updated first. Returns lightweight summary items including page and widget counts. Archived reports are excluded by default; pass include_archived=true to include them.



## OpenAPI

````yaml https://api.surnex.io/openapi.json get /v1/projects/{project_id}/reports
openapi: 3.1.0
info:
  title: Surnex API
  description: |-
    Surnex SEO Platform API — api.surnex.io

    Provides the complete backend for the Surnex SEO dashboard including:
    - Multi-tenant organization management
    - Project tracking (domains)
    - Keyword rank tracking (Phase 1+)
    - Backlink analysis (Phase 3+)
    - Site auditing (Phase 4+)
    - Stripe billing integration
    - MCP endpoint for AI agents at /mcp
  version: 0.1.0
servers: []
security: []
paths:
  /v1/projects/{project_id}/reports:
    get:
      tags:
        - Reports
      summary: List reports
      description: >-
        List all reports for a project, ordered by most recently updated first.
        Returns lightweight summary items including page and widget counts.
        Archived reports are excluded by default; pass include_archived=true to
        include them.
      operationId: list_reports_v1_projects__project_id__reports_get
      parameters:
        - name: project_id
          in: path
          required: true
          schema:
            type: string
            format: uuid
            title: Project Id
        - name: include_archived
          in: query
          required: false
          schema:
            type: boolean
            description: When true, include archived reports in the response.
            default: false
            title: Include Archived
          description: When true, include archived reports in the response.
        - name: page
          in: query
          required: false
          schema:
            type: integer
            minimum: 1
            description: Page number
            default: 1
            title: Page
          description: Page number
        - name: per_page
          in: query
          required: false
          schema:
            type: integer
            maximum: 100
            minimum: 1
            description: Items per page
            default: 25
            title: Per Page
          description: Items per page
        - name: X-API-Key
          in: header
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: X-Api-Key
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedResponse_ReportListItem_'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - HTTPBearer: []
components:
  schemas:
    PaginatedResponse_ReportListItem_:
      properties:
        success:
          type: boolean
          title: Success
          default: true
        data:
          items:
            $ref: '#/components/schemas/ReportListItem'
          type: array
          title: Data
        meta:
          $ref: '#/components/schemas/PaginationMeta'
      type: object
      required:
        - data
        - meta
      title: PaginatedResponse[ReportListItem]
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ReportListItem:
      properties:
        id:
          type: string
          format: uuid
          title: Id
        name:
          type: string
          title: Name
        description:
          anyOf:
            - type: string
            - type: 'null'
          title: Description
        page_count:
          type: integer
          title: Page Count
          description: Total number of pages in this report.
        widget_count:
          type: integer
          title: Widget Count
          description: Total number of widgets across all pages in this report.
        is_archived:
          type: boolean
          title: Is Archived
        schedule_enabled:
          type: boolean
          title: Schedule Enabled
          default: false
        updated_at:
          type: string
          format: date-time
          title: Updated At
        created_at:
          type: string
          format: date-time
          title: Created At
      type: object
      required:
        - id
        - name
        - page_count
        - widget_count
        - is_archived
        - updated_at
        - created_at
      title: ReportListItem
      description: |-
        Lightweight report summary for list endpoints.

        page_count and widget_count are computed aggregates, not direct ORM
        attributes. Services must populate these fields manually (e.g., via
        SQL COUNT subqueries or Python aggregation after loading the report).
    PaginationMeta:
      properties:
        page:
          type: integer
          minimum: 1
          title: Page
          description: Current page number (1-indexed)
        per_page:
          type: integer
          maximum: 500
          minimum: 1
          title: Per Page
          description: Number of items per page
        total:
          type: integer
          minimum: 0
          title: Total
          description: Total number of items across all pages
      type: object
      required:
        - page
        - per_page
        - total
      title: PaginationMeta
      description: Pagination metadata included in list responses.
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer

````