---
title: "Email Dashboard"
method: POST
path: "/api/v1/dashboards/{dashboard_id}/email"
tags: ["dashboards"]
---

# Email Dashboard

`POST /api/v1/dashboards/{dashboard_id}/email`

## Request

- Base URL: `https://api.getanana.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api.getanana.com/api/v1/dashboards/{dashboard_id}/email`
- Auth: none declared

Email the dashboard to anyone, with its figures read now, as the sender sees
them.

## Path parameters

- `dashboard_id` string, uuid, required

## Request body

- DashboardEmailRequest: Send the dashboard with the dates and filters on the sender's screen.
  - `recipients` string[], required
  - `note` string, nullable
  - `scope` ReportScope, required: The resolved scope a report/automation renders under: an inclusive local date range plus the four global dimension selections. Empty selections = "all", reproducing the dashboard's default (unfiltered) view.
    - `start_date` string, required
    - `end_date` string, required
    - `start_datetime` string, nullable
    - `end_datetime` string, nullable
    - `hotel` DimensionSelection: One global dimension's include/exclude selection (mirrors the frontend ReportingFiltersContext dimension).
      - `include` string[]
      - `exclude` string[]
    - `agent` DimensionSelection: One global dimension's include/exclude selection (mirrors the frontend ReportingFiltersContext dimension).
      - `include` string[]
      - `exclude` string[]
    - `interaction_type` DimensionSelection: One global dimension's include/exclude selection (mirrors the frontend ReportingFiltersContext dimension).
      - `include` string[]
      - `exclude` string[]
    - `booking_source` DimensionSelection: One global dimension's include/exclude selection (mirrors the frontend ReportingFiltersContext dimension).
      - `include` string[]
      - `exclude` string[]
    - `comparison` 'previous_period' | 'previous_week' | 'previous_month' | 'previous_year', nullable

## Response `200`

Successful Response

- DashboardEmailResponse
  - `message_id` string, nullable, required
  - `sent_at` string, date-time, required
  - `recipients` string[], required

## Other responses

- `403`: Error
- `404`: Error
- `422`: Validation Error
- `502`: Error

## Changes

> 55 revisions in range; 1 not diffed.

- **2026-10-18** `5dbe6a2613cb`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/getanana/apis/cleon-api/changes/api/v1/dashboards/:dashboard_id/email/post.md)

---

[API](https://skmtc.dev/getanana/apis/cleon-api.md) · [All operations](https://skmtc.dev/getanana/apis/cleon-api/llms.txt) · [OpenAPI document](https://skmtc.dev/getanana/apis/cleon-api/revisions/4d9d38769a75?raw)