OPopenobserve
Reports

Create dashboard report

Creates a new automated dashboard report configuration. Reports can be scheduled to automatically generate and distribute dashboard snapshots via email or other notification channels. Includes support for custom time ranges, recipient lists, delivery schedules, and output formats to keep stakeholders informed of key metrics and trends.

post/api/{org_id}/reports

Request

Path parameters

org_idstring required

Organization name

Request body

createdAtstring date-time
descriptionstring
enabledboolean
imagePreviewboolean

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.

lastEditedBystring
messagestring

Message to include in the email

namestring
orgIdstring required
ownerstring
startinteger

Start time of report generation in UNIX microseconds.

timezonestring
timezoneOffsetinteger

Fixed timezone offset in minutes

titlestring
updatedAtstring date-time

Response

Report created

codeinteger required
error_detailstring nullable
hintstring nullable

One-line guidance on how to fix the error (agent self-correction, D4).

idstring nullable
messagestring required
namestring nullable
suggestionsstring[] nullable

Closest valid alternatives for a mistyped field/function name.

trace_idstring nullable
warningsstring[] nullable

Problems with a request that succeeded anyway. Distinct from hint, which explains a failure: these accompany a 200, and the caller is entitled to have meant it.

Changes

No recorded changes to this operation across all 1 revision of this API.