Reports

Get dashboard report

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.

get/api/{org_id}/reports/{name}

Request

Path parameters

org_idstring required

Organization name

namestring required

Report name

Response

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

Changes

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