List JSON reports backed by materialized views |

Operation

GET /reports

Returns major report aliases plus the accessible raw materialized-view reports available to the authenticated user. Agents should use major_reports first when they need help choosing the right report.

Operation ID: listReports · Tags: Reports

Parameters

This operation does not define any parameters.

Request Body

No request body is defined for this operation.

Responses

Content Types

application/json

{
  "description": "Report catalog",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "properties": {
          "major_reports": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ReportMetadata"
            }
          },
          "reports": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ReportMetadata"
            }
          },
          "meta": {
            "type": "object",
            "properties": {
              "total_major_reports": {
                "type": "integer"
              },
              "total_reports": {
                "type": "integer"
              },
              "default_limit": {
                "type": "integer"
              },
              "max_limit": {
                "type": "integer"
              },
              "note": {
                "type": "string"
              }
            }
          }
        },
        "required": [
          "major_reports",
          "reports",
          "meta"
        ]
      }
    }
  }
}

{
  "$ref": "#/components/responses/Unauthorized"
}

API Playground

Run this GET request with your API key, or open it in a new tab. Path uses sample IDs where the OpenAPI path has {parameters}. Sign in to enable live testing with your API key.

Action	Method	Endpoint	Description
List JSON reports backed by materialized views	`GET`	`/api/v1/reports`	OpenAPI operationId: listReports.

GET /api/v1/reports OpenAPI

List JSON reports backed by materialized views

Open