GOgooddata
export-reports

Export all reports in a dashboard tab

This resource exports all computable reports in a dashboard tab to one file (XLSX or PDF). In the XLSX format, all reports are converted into tables.Request body parameters

  • dashboard (string) specifies the dashboard that the tab to export belongs to.

  • format (string) specifies the format that the tab reports will be exported to. Can be set to xlsx or pdf.

  • options (JSON, optional) specifies advanced exporting options. For more information, See Export a Report.

  • tab (string) specifies the dashboard tab to export.

  • context (string, optional) applies a predefined set of filters (execution context) to the dashboard tab to export. If you do not have existing execution contexts in your project, first create one.

post/gdc/projects/{project_id}/export/dashboardTab

Request

  • Base URL
    https://secure.gooddata.com
  • Auth
    none declared

Path parameters

project_idstring required

ID of the project that the dashboard to export belongs to.

Request body

Example request

{
  "exportDashboardTab": {
    "dashboard": "/gdc/md/{project_id}/obj/{dashboard_id}",
    "options": {
      "mergeHeaders": true
    }
  }
}

Response

201 returns the URI to poll on. Polling returns various HTTP codes depending on whether the export is still running or not. When the export is finished, the response returns 200 and the exported file.

Example response

{
  "asyncTask": {
    "link": {
      "poll": "/gdc/uri/poll"
    }
  }
}

Changes

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