---
title: "Start a report job"
method: POST
path: "/v2/dashboards/reportJobs"
tags: ["dashboardManagement"]
---

# Start a report job

`POST /v2/dashboards/reportJobs`

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](#operation/getAsyncExportStatus) endpoint and the job identifier you got back in the response to track the status of an asynchronous report generation job.

## Request body

- GenerateReportRequest
  - `action` ReportAction, required — The base class of all report action types. `DirectDownloadReportAction` downloads dashboard from browser. New action types may be supported in the future.
    - `actionType` string, required — Type of action.
  - `exportFormat` string, required — File format of the report. Can be `Pdf` or `Png`. `Pdf` is portable document format. `Png` is portable graphics image format.
  - `timezone` string, required — Time zone for the query time ranges. Follow the format in the [IANA Time Zone Database](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List).
  - `template` Template, required
    - `templateType` string, required — The type of template. `DashboardTemplate` provides a snapshot view of the exported dashboard. `DashboardReportModeTemplate` provides a printer-friendly view of the exported dashboard. New templates may be supported in the future.
  - `theme` string — Theme for the report rendering. If absent, the default theme of the dashboard is used.
  - `exportWidth` integer — Pixel width of the exported PDF or PNG. If absent, the default width is used.

## Response `200`

Export job has been scheduled.

- BeginAsyncJobResponse
  - `id` string, required — Identifier to get the status of an asynchronous job.

## Other responses

- `default` — Operation failed with an error.

---

[API](https://skmtc.net/sumologic/apis/sumo-logic-api.md) · [All operations](https://skmtc.net/sumologic/apis/sumo-logic-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/sumologic/sumo-logic-api/revisions/e4e4c7554890/schema)