GOgooddata
PDF-export-settings

Get headers and footers for PDF report exports

Get headers and footers for PDF report exports in your project to review them and check whether they have been customized.

By default, a non-customized PDF file for an exported report or dashboard contains the following standard headers and footers:

* Header
  * Left: report/dashboard name
  * Right: date of export
* Footer
  * Right: page number/pages in total

If headers and footers for PDF report exports in your project have been customized, the response contains parameters that describes the following properties of PDF report exports:

  • Dashboard

    • All pages
      • Footer (left and right)
      • Header (left, right and center)
    • First page (overriding the settings from all pages)
      • Header (left and right)

  • Reports

    • All pages
      • Footer (left, right and center)
      • Header (left, right and center)
    • First page (overriding the settings from all pages)
      • Header (left, right and center)

Header and footer values can contain text strings, predefined macros, or both. For example:

"header": {
  "center": "Copyright 2007 - 2018",
  "left": "%DASHBOARD_NAME",
  "right": "Project %PROJECT_NAME"
}

For information on available macros, see Configure Custom Headers and Footers for PDF Report Exports.

get/gdc/app/projects/{project_id}/export/pdfSettings

Request

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

Path parameters

project_idstring required

The ID of the project where you want to customize or get information about headers and footers for PDF exports.

Response

Headers and footers for PDF report exports in your project have been customized.

Changes

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