v1

latestOpenAPI 3.0.02026-08-064311,0881.3 MB

dashboardManagement

Start a report job

Schedule an asynchronous job to generate a report from a template. All items in the template will be included unless specified. See template section for more details on individual templates. Reports can be generated in Pdf or Png format and exported in various methods (ex. direct download). You will get back an asynchronous job identifier on success. Use the getAsyncReportGenerationStatus endpoint and the job identifier you got back in the response to track the status of an asynchronous report generation job.

post/v2/dashboards/reportJobs

Request body

exportFormatstring required

File format of the report. Can be Pdf or Png. Pdf is portable document format. Png is portable graphics image format.

timezonestring required

Time zone for the query time ranges. Follow the format in the IANA Time Zone Database.

themestring

Theme for the report rendering. If absent, the default theme of the dashboard is used.

exportWidthinteger

Pixel width of the exported PDF or PNG. If absent, the default width is used.

Example request

{
  "action": {
    "actionType": "DirectDownloadReportAction"
  },
  "exportFormat": "Pdf",
  "timezone": "America/Los_Angeles",
  "template": {
    "templateType": "DashboardTemplate"
  },
  "theme": "Light",
  "exportWidth": 1500
}

Response

Export job has been scheduled.

idstring required

Identifier to get the status of an asynchronous job.

Example response

{
  "id": "C03E086C137F38B4"
}