---
title: "List reports"
method: GET
path: "/api/v1/analytics/report"
tags: ["Report"]
---

# List reports

`GET /api/v1/analytics/report`

Returns a list of reports (official Xentral reports and custom reports)

## Response `200`

Report response

- object
  - `data` object[], nullable, required
    - `id` number — Report ID
    - `title` string, required — Report title
    - `description` string — Report description
    - `userId` number — User ID of the report creator
    - `sqlString` string, required — SQL query string
    - `isFavorite` boolean — Is report marked as favorite
    - `isReadOnly` boolean — Is report read-only
    - `collectionId` number, required — ID of the collection the report belongs to
    - `lastEditedBy` string — User who last edited the report
    - `tags` object[]
      - `id` number, required — Tag ID
      - `name` string, required — Tag name
      - `description` string — Tag description
      - `palette` 'default' | 'warning' | 'success' | 'danger' | 'primary' — The palette value of the tag
      - `isOfficial` boolean — Whether the tag is used for official Xentral reports
      - `createdAt` string, date-time — Creation time
      - `updatedAt` string, date-time — Last update time
    - `parameters` object[], nullable
      - `name` string, required — Parameter name
      - `type` string, required — Parameter type
      - `defaultValue` string, required — Default value for parameter you want to store
      - `valueMap` object[] — Array of dropdown options with label and value properties. Values will be rendered in the query, labels are displayed in the dropdown.
        - `label` string, required — Display label shown in the dropdown
        - `value` string, required — Value used in the query
    - `createdAt` string, date-time — Creation time
    - `updatedAt` string, date-time — Last update time

## Other responses

- `400` — IETF RFC 9457 Problem API compliant response
- `401` — Unable to authenticate the client
- `403` — Unable to authorize the client
- `404` — Resource was not found or not enough access privileges
- `415` — Resource representation send in the request is not supported.

---

[API](https://skmtc.net/xentral/apis/xentral-api.md) · [All operations](https://skmtc.net/xentral/apis/xentral-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/xentral/xentral-api/versions/8a27ba392442/schema)