export-reports

Export a report

For more information, see Export a Report use case.

Additional export options Export API request may contain additional options to customize the output file (applicable only to tabular report in PDF or XLS format). Options are specified under exportOptions key:

  • pageOrientation ("portrait" or "landscape", optional) Specifies page orientation of the file produced. Default is "portrait".

  • optimalColumnWidth ("yes" or "no", optional) Specifies whether the column width in the exported PDF file should be uniform or adjusted according to the actual column data, default is "no".

  • scaling (PDF export only, optional) - Specifies scaling of the page. Scaling applies to both landscape and portrait orientations.

    • pageScalePercentage (number, optional) - Specifies a percentage to scale the exported PDF. Cannot be used with other scaling keywords. Default: 100
    • scaleToPages (number, optional) - Specifies a maximum number of pages for the exported PDF. Cannot be used with other scaling keywords.
    • scaleToPagesX (number, optional) - Shrinks the horizontal content of the exported PDF to a maximum of this number of pages. Often used with the scaleToPagesY keyword. Cannot be combined with the pageScalePercentage or scaleToPages keywords.
    • scaleToPagesY (number, optional) - Shrinks the vertical content of the exported PDFs to a maximum number of pages. Often used with the scaleToPagesX keyword. Cannot be combined with the pageScalePercentage or scaleToPages keywords.
  • mergeHeaders ("yes" or "no", XLSX export only, optional) - Merges repeating header cells. Default is "yes".The content of the result section is execResult JSON (which is returned after report computation).

  • urlParams - URL parameters needed to be propagated to the exported dashboard URL to support dashboard macros (to make macros like %URL_PARAM(<param_name>)% be rendered correctly).

post/gdc/exporter/executor

Request

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

Request body

Response

_

uristring uri required

Example response

{
  "uri": "/gdc/uri"
}

Changes

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