---
title: "GET /reporting/reports"
method: GET
path: "/reporting/reports"
tags: ["Reports"]
---

# GET /reporting/reports

`GET /reporting/reports`

Get the reports available in the collection.

## Query parameters

- `limit` integer
- `offset` integer
- `events.created.at` string, date-time
- `events.started.at` string, date-time
- `events.terminated.at` string, date-time
- `events.updated.at` string, date-time
- `id` string
- `name` string
- `schedule.id` string
- `status` 'pending' | 'deploying' | 'running' | 'succeeded' | 'failed'
- `template.id` string
- `template.name` string
- `template.type` 'system' | 'custom'
- `timeout` boolean

## Response `200`

- ReportingReport[]
  - `id` string
  - `name` string, required
  - `description` string, nullable
  - `revision` integer
  - `template` ReportingReportTemplateReference, required — Report template. Is used to represent template attached to this report
    - `id` string
    - `name` string, required
    - `description` string, required
    - `type` string, required
    - `specs_version` string, required
    - `revision` integer
    - `repository` ReportingReportRepositoryReference, required — Report repository. Is used to represent repository attached to this report
      - `id` string
      - `name` string, nullable
      - `git` ReportingGitInfo, required — Git Info. Is used to represent git repository information
        - `url` string, uri, required
        - `tag` string, required
        - `commit` string, nullable
        - `auth` ReportingGitCredentials — Git Credentials. Is used to represent input object to request git tags. You need to provide `username` and `password` to your git repository as input data.
          - `username` string, nullable
          - `password` string, nullable
    - `entrypoint` string, required
    - `local_id` string, required
  - `parameters` object, nullable
  - `events` object
    - `created` object
      - `at` string, datetime
      - `by` object
        - `id` string
        - `name` string
        - `icon` string
    - `updated` object
      - `at` string, datetime
      - `by` object
        - `id` string
        - `name` string
        - `icon` string
    - `started` object
      - `at` string, datetime
      - `by` object
        - `id` string
        - `name` string
        - `icon` string
    - `terminated` object
      - `at` string, datetime
      - `by` object
        - `id` string
        - `name` string
        - `icon` string
  - `report_size` integer, nullable
  - `timeout` boolean
  - `status` 'pending' | 'deploying' | 'running' | 'succeeded' | 'failed'
  - `owner` ReportingAccountReference, required
    - `id` string
    - `name` string, required
  - `failure_output` string, nullable
  - `schedule` ReportingReportScheduleReference, required — ReportSchedule. For scheduled reports, represents a reference to the related schedule object.
    - `id` string
    - `name` string, required
  - `renderer` string
  - `report_file` string
  - `report_extension` string
  - `progress` ReportingReportStatsProgress, required — Report stats. Is used to represent current (`value`) and maximum (`max`) progress of the report
    - `value` integer, required
    - `max` integer, required
  - `timing` ReportingReportTiming — Report timing. Is used to represent `run` and `wait` properties of the report
    - `run` string
    - `wait` string

## Other responses

- `400`

---

[API](https://skmtc.net/cloudblue/apis/cloudblue-connect-api.md) · [All operations](https://skmtc.net/cloudblue/apis/cloudblue-connect-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/cloudblue/cloudblue-connect-api/revisions/0421d2a97c52/schema)