---
title: "Manually trigger dashboard report"
method: PUT
path: "/api/{org_id}/reports/{name}/trigger"
tags: ["Reports"]
---

# Manually trigger dashboard report

`PUT /api/{org_id}/reports/{name}/trigger`

## 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}/trigger`
- Auth: API key in header `Authorization`
- TypeScript: <https://skmtc.dev/openobserve/apis/openobserve-api-http/docs/api/:org_id/reports/:name/trigger/put.ts> (a function with typed inputs; its response is checked against the schema)

Manually triggers immediate execution of a dashboard report outside of its regular schedule. Generates the report with current data and delivers it to configured destinations. Useful for ad-hoc reporting needs, testing report configurations, or providing immediate updates to stakeholders between scheduled deliveries.

## Path parameters

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

## Response `200`

Report sent; `run` is the history row of the run

- object: Reply to Run now: the run is returned before the stream copy becomes searchable.
  - `code` integer, required
  - `message` string, required
  - `run` ReportRunHit, required: One report run as the history API returns it.
    - `attachment_type` string, nullable
    - `dashboard_count` integer, nullable
    - `delay_in_secs` integer, nullable
    - `delivery_attempted` boolean, nullable
    - `duration_ms` integer, nullable
    - `error` string, nullable
    - `finished_at` integer, nullable
    - `is_cached` boolean, required
    - `is_partial` boolean, required
    - `next_run_at` integer, nullable: The run after this one; provisional on a failed row.
    - `recipient_count` integer, nullable
    - `report_id` string, required
    - `report_name` string, required: Empty when the report was deleted.
    - `retries` integer, required
    - `scheduled_for` integer, nullable: The run's due time; null on rows written before it was recorded.
    - `scheduler_trace_id` string, nullable
    - `source_node` string, nullable
    - `status` string, required
    - `time_in_queue_ms` integer, nullable
    - `timestamp` integer, required: `_timestamp` of the row: when the run was picked up.
    - `trigger_source` string, required
    - `triggered_by` string, nullable

## Other responses

- `404`: NotFound
- `500`: Send failed; `run` carries the error

---

[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)