export.

export_pdf

export_pdf(workspace_id: str, dashboard_id: str, file_name: str, store_path: Union[str, Path] = Path.cwd(), timeout: float = 60.0, retry: float = 0.2, max_retry: float = 5.0, metadata: Optional[Dict[str, Any]] = None, )

Export a PDF of the specified GoodData Dashboard and save it to the specified file path.

Parameters

nametypedescription
workspace_idstringThe ID of the GoodData Workspace.
dashboard_idstringThe ID of the GoodData Dashboard.
file_nameStringThe name of the PDF file (excluding the file extension).
store_pathUnion[String, Path]The name of the PDF file (excluding the file extension).
timeoutfloatThe maximum amount of time (in seconds) to wait for the server to process the export. Defaults to 60.0.
retryfloatInitial wait time (in seconds) before retrying to get the exported content. Defaults to 0.2.
max_retryfloatThe maximum retry wait time (in seconds). Defaults to 5.0.
metadataOptional[Dict[str, Any]]Specify the metadata for the export. Specific metadata can override filtering.

Returns

None

Example


host = "https://www.example.com"
token = "<your_personal_access_token>"
sdk = GoodDataSdk.create(host, token)


sdk.export.export_pdf(workspace_id="demo",  dashboard_id="campaign", file_name="test")