This documentation is for an older version of GoodData.
Go to the latest version of this article.
export.
export_tabular_by_visualization_id
export_tabular_by_visualization_id( workspace_id: str, visualization_id: str, file_format: str, file_name: Optional[str] = None, settings: Optional[ExportSettings] = None, store_path: Union[str, Path] = Path.cwd(), timeout: float = 60.0, retry: float = 0.2, max_retry: float = 5.0, )
Exports the tabular data for an visualization by its ID.
Parameters
name | type | description |
---|---|---|
workspace_id | string | The ID of the GoodData Workspace. |
visualization_id | string | The ID of the GoodData visualization. |
file_format | string | The format of the file to be exported. |
file_name | String | The name which the exported file should have. Defaults to None. |
settings | Optional[ExportSettings] | Any additional settings for the export. Defaults to None. |
store_path | Union[String, Path] | The path to store the exported file. Defaults to Path.cwd(). |
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. |
Returns
None
Example
host = "https://www.example.com"
token = "<your_personal_access_token>"
sdk = GoodDataSdk.create(host, token)
sdk.export.export_tabular_by_visualization_id(
workspace_id="demo", visualization_id="campaign_spend", file_format="CSV")