This documentation is for the unstable version of GoodData, currrently in development.
For stable version, go to the latest stable version of this article.
For stable version, go to the latest stable version of this article.
ExportService.
export_pdf
export_pdf(workspace_id: str, dashboard_id: str, file_name: str, store_path: Union[str, Path], timeout: float, retry: float, max_retry: float, metadata: Dict[str, Any]) ->
None
Export a PDF of the specified GoodData Dashboard and save it to the specified file path.
Parameters
name | type | description |
---|---|---|
workspace_id | str | The ID of the GoodData Workspace. |
dashboard_id | str | The ID of the GoodData Dashboard. |
file_name | str | The name of the PDF file (excluding the file extension). |
store_path | Union[str, Path] | The path to save the exported PDF. Defaults to the current directory. |
timeout | float | The maximum amount of time (in seconds) to wait for the server to process the export. Defaults to 60.0. |
retry | float | Initial wait time (in seconds) before retrying to get the exported content. Defaults to 0.2. |
max_retry | float | The maximum retry wait time (in seconds). Defaults to 5.0. |
metadata | Dict[str, Any] | Specify the metadata for the export. Specific metadata can override filtering. |