---
title: "Returns a list of reports available for export."
method: GET
path: "/report"
tags: ["Report"]
---

# Returns a list of reports available for export.

`GET /report`

## Request

- Base URL: `https://api.reveldigital.com`
- URL: `https://api.reveldigital.com/report`
- Auth: one of:
  - OAuth 2
    - Authorization code: `https://id.reveldigital.com/connect/authorize`
    - Token URL: `https://id.reveldigital.com/connect/token` scopes: `webapi`
  - API key in header `X-RevelDigital-ApiKey`
  - API key in query parameter `api_key`
- TypeScript: <https://skmtc.dev/reveldigital/apis/revel-digital-rest-api/docs/report/get.ts> (a function with typed inputs; its response is checked against the schema)

## Query parameters

- `id` string

## Response `200`

OK

- Report[]: A collection of RevelDigital.Core.PublicApi.Models.Report items for XML serialization.
  - `id` string, nullable: The unique identifier for the report. Corresponds to the SSRS report path/name.
  - `name` string, nullable: The display name of the report shown in the UI.
  - `description` string, nullable: A description of what the report contains and its purpose.
  - `parameters` ReportParameter[], nullable: The list of parameters required or optional for generating this report. Parameters define filters such as date range, device selection, or grouping options.
    - `id` string, nullable: The parameter identifier used when submitting report requests. This is the SSRS parameter name.
    - `name` string, nullable: The display name/prompt shown to users when entering the parameter value.
    - `required` boolean: Indicates whether this parameter must be provided to generate the report. True if the parameter is not nullable and does not allow blank values.
    - `multi_value` boolean: Indicates whether this parameter accepts multiple values. When true, an array of values can be submitted for this parameter.

---

[API](https://skmtc.dev/reveldigital/apis/revel-digital-rest-api.md) - [All operations](https://skmtc.dev/reveldigital/apis/revel-digital-rest-api/llms.txt) - [OpenAPI document](https://skmtc.dev/reveldigital/apis/revel-digital-rest-api/revisions/39d5c8302822?raw)