---
title: "Get dashboard report"
method: GET
path: "/api/{org_id}/reports/{name}"
tags: ["Reports"]
---

# Get dashboard report

`GET /api/{org_id}/reports/{name}`

## Request

- Base URL: `https://api.openobserve.ai` (the document declares no server; this is the origin it was published from)
- URL: `https://api.openobserve.ai/api/{org_id}/reports/{name}`
- Auth: API key in header `Authorization`
- TypeScript: <https://skmtc.dev/openobserve/apis/openobserve-api-http/docs/api/:org_id/reports/:name/get.ts> (a function with typed inputs; its response is checked against the schema)

Retrieves the complete configuration and details for a specific dashboard report. Returns report parameters including schedule settings, dashboard selection, recipient lists, delivery options, and execution status. Used for reviewing existing report configurations before making modifications or troubleshooting delivery issues.

## Path parameters

- `org_id` string, required
- `name` string, required

## Response `200`

- object
  - `createdAt` string, date-time
  - `dashboards` ReportDashboard[], required
    - `attachment_dimensions` ReportAttachmentDimensions
      - `height` integer, required
      - `width` integer, required
    - `dashboard` string, required
    - `email_attachment_type` 'standard' | 'inline'
    - `folder` string, required
    - `report_type` 'pdf' | 'png' | 'csv'
    - `tabs` string[], required
    - `timerange` ReportTimerange
      - `from` integer, required
      - `period` string, required
      - `to` integer, required
      - `type` 'relative' | 'absolute', required
    - `variables` ReportDashboardVariable[]
      - `id` string, nullable
      - `key` string, required
      - `value` string, required
  - `description` string
  - `destinations` ReportDestination[], required
    - `email` string, required
  - `enabled` boolean
  - `frequency` ReportFrequency
    - `align_time` boolean
    - `cron` string: Cron expression
    - `interval` integer: Frequency interval in the `frequency_type` unit
    - `type` 'once' | 'hours' | 'days' | 'weeks' | 'months' | 'cron'
  - `imagePreview` boolean: When `true` and the report type is PDF, a PNG screenshot is also captured and embedded inline in the email body alongside the PDF attachment.
  - `lastEditedBy` string
  - `message` string: Message to include in the email
  - `name` string
  - `orgId` string, required
  - `owner` string
  - `start` integer: Start time of report generation in UNIX microseconds.
  - `timezone` string
  - `timezoneOffset` integer: Fixed timezone offset in minutes
  - `title` string
  - `updatedAt` string, date-time

## Other responses

- `404`: Report not found

---

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