---
title: "GET /v1/reports/{id}"
method: GET
path: "/v1/reports/{id}"
tags: ["reports"]
---

# GET /v1/reports/{id}

`GET /v1/reports/{id}`

## Request

- Base URL: `https://help.steep.app` (the document declares no server; this is the origin it was published from)
- URL: `https://help.steep.app/v1/reports/{id}`
- Auth: none declared

Read a report's full contents by `id`: title, each text block's heading and body, and the titles of chart/table/big-number/map blocks, in document order. Does not run metric queries.

## Path parameters

- `id` string, required: The `id` of the report.

## Response `200`

Response for status 200

- object
  - `data` object, required
    - `id` string, required
    - `title` string, required
    - `createdAt` string, date-time, required: When the report was created.
    - `updatedAt` string, date-time, required: When the report was last updated.
    - `author` object, required: The user who created the report. Null if the creator is unknown.
      - `id` string, required: The id of the user who created the report.
      - `name` unknown, required
    - `link` string, required: Link to the report in the Steep app.
    - `blocks` union[], required
      - union
        - object
          - `id` string, required
          - `type` string, required
          - `heading` string, required
          - `headingSize` 'large' | 'small', required
          - `body` string, required
        - object
          - `id` string, required
          - `type` 'chart' | 'table' | 'big-number' | 'map', required
          - `title` unknown, required
          - `metrics` object[], required: The metrics visualized in this block, in display order. Empty for map blocks.
            - `metricId` string, required: The metric this series visualizes. Use query metric to fetch values, or get metric by `id` for its definition.
            - `sliceId` unknown, required
          - `timeFilter` unknown, required
          - `fromDate` unknown, required
          - `toDate` unknown, required

## Other responses

- `401`: Response for status 401
- `403`: Response for status 403
- `422`: Response for status 422
- `429`: Response for status 429
- `500`: Response for status 500

---

[API](https://skmtc.dev/steep/apis/steep-api.md) - [All operations](https://skmtc.dev/steep/apis/steep-api/llms.txt) - [OpenAPI document](https://skmtc.dev/steep/apis/steep-api/revisions/cc9677742952?raw)
