reports
enterprise

Send test report via email.

Available to org admins only and with a valid license.

You need to have a permission with action reports:send.

post/reports/test-email

Request

  • Base URL
    /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /api/reports/test-email
  • Auth
    • HTTP basic
    • or API key in header Authorization

Request body

dashboardIdinteger
dashboardUidstring
enableCsvboolean
enableDashboardUrlboolean
formatsType[]
messagestring
namestring
recipientsstring
replyTostring
scaleFactorinteger
statestring
templateVarsobject

Response

An OKResponse is returned if the request was successful.

messagestring

Changes

No recorded changes to this operation across all 2 revisions of this API.