Skip to main content
Skip to sidebar
Skip to search
GoodData Logo
Learn
Learn
University
Community
Documentation
Support
Go to GoodData.com
Request a demo
All Products
Python SDK
Ask AI
Version (1.63)
dev
1.63
1.62
1.61
1.60
GitHub
All Products
Python SDK
Version (1.63)
dev
1.63
1.62
1.61
1.60
Python SDK
Introduction
Installation
Getting Started
Pandas Overview
Pipelines Overview
Administration
Organization
update_name
create_or_update_jwk
delete_jwk
get_jwk
list_jwks
Appearance
list_themes
get_theme
create_theme
update_theme
delete_theme
list_color_palettes
get_color_palette
create_color_palette
update_color_palette
delete_color_palette
Permissions
get_declarative_organization_permissions
get_declarative_permissions
manage_dashboard_permissions
list_dashboard_permissions
list_available_assignees
manage_organization_permissions
put_declarative_organization_permissions
put_declarative_permissions
Users
create_or_update_user
create_user_api_token
delete_user_api_token
get_user_api_token
get_user_permissions
list_user_api_tokens
manage_user_permissions
get_user
delete_user
list_users
get_declarative_users
put_declarative_users
store_declarative_users
load_declarative_users
load_and_put_declarative_users
User Groups
get_user_group_permissions
manage_user_group_permissions
create_or_update_user_group
get_user_group
delete_user_group
list_user_groups
get_declarative_user_groups
put_declarative_user_groups
store_declarative_user_groups
load_declarative_user_groups
load_and_put_declarative_user_g...
Notification channels
get_declarative_notification_channels...
put_declarative_notification_channels...
Users and User Groups
assign_permissions_bulk
revoke_permissions_bulk
get_declarative_users_user_grou...
put_declarative_users_user_grou...
store_declarative_users_user_gro...
load_declarative_users_user_gro...
load_and_put_declarative_users...
Data Connection
Data Source
create_or_update_data_source
get_data_source
delete_data_source
patch_data_source_attributes
list_data_sources
get_declarative_data_sources
put_declarative_data_sources
store_declarative_data_sources
load_declarative_data_sources
load_and_put_declarative_data...
generate_logical_model
register_upload_notification
scan_data_source
scan_pdm_and_generate_logical_model
staging_upload
analyze_csv
import_csv
delete_csv_files
upload_csv
scan_schemata
scan_sql
test_data_sources_connection
Physical Data Model
load_pdm_from_disk
store_pdm_to_disk
Execution
Dashboard Export
export_pdf
export_tabular
export_tabular_by_visualization_id
GoodData AI (beta)
ai_chat
ai_chat_stream
build_exec_def_from_chat_result
ai_chat
reset_ai_chat_history
search_ai
sync_metadata
set_ai_chat_history_feedback
Workspace
Workspaces
create_or_update
get_workspace
clone_workspace
delete_workspace
list_workspaces
get_declarative_automations
get_declarative_workspaces
put_declarative_automations
put_declarative_workspaces
store_declarative_workspaces
load_declarative_workspaces
load_and_put_declarative_work...
get_declarative_workspace
put_declarative_workspace
store_declarative_workspace
load_declarative_workspace
load_and_put_declarative_work...
load_and_put_aac_workspace
get_and_store_aac_workspace
Workspace Data Filters
get_declarative_workspace_data_f...
put_declarative_workspace_data_f...
store_declarative_workspace_dat...
load_declarative_workspace_data_...
load_and_put_declarative_worksp...
Workspace content
Logical Data Model
get_declarative_ldm
put_declarative_ldm
store_declarative_ldm
store_ldm_to_disk
load_ldm_from_disk
load_declarative_ldm
load_and_put_declarative_ldm
Metadata Localization
add_metadata_locale
get_metadata_localization
set_metadata_localization
add_metadata_locale
save_metadata_locale_to_disk
set_metadata_locale_from_disk
Analytics Model
get_declarative_analytics_model
put_declarative_analytics_model
store_declarative_analytics_model
store_analytics_model_to_disk
load_analytics_model_from_disk
load_declarative_analytics_model
load_and_put_declarative_analyt...
Workspace Contents
for_visualization
for_items
get_visualization
get_visualizations
get_full_catalog
get_metrics_catalog
get_facts_catalog
get_attributes_catalog
get_labels_catalog
get_dependent_entities_graph
get_dependent_entities_graph_f...
GOODDATA PANDAS
data_access
ExecutionDefinitionBuilder
build_execution_definition
dataframe
DataFrameFactory
for_created_visualization
for_exec_def
for_exec_result_id
for_items
for_visualization
indexed
not_indexed
result_cache_metadata_for_exec_result_id
good_pandas
GoodPandas
create_from_profile
data_frames
series
result_convertor
_AbstractAccumulatedData
accumulate_data
accumulate_grand_totals
accumulate_headers
extend_existing_row_data
result
_AccumulatedData
_AttributeNameLocal
_AttributeValuePrimary
_DataWithHeaders
_Header
get
_HeaderContainer
append
extend
_MeasureHeader
_OptimizedAccumulatedData
_TotalHeader
DataFrameMetadata
from_data
utils
DefaultVisualizationColumnNaming
col_name_for_attribute
col_name_for_metric
GOODDATA PIPELINES
Provisioning
Workspaces
Users
User Group
User Data Filters
Workspace Permissions
Backup & Restore
Configuration
Workspace Backup
Workspace Restore
LDM Extension
API Reference
catalog
appearance
entity_model
color_palette
CatalogColorPalette
CatalogColorPaletteAttributes
theme
CatalogTheme
CatalogThemeAttributes
service
CatalogAppearanceService
create_color_palette
create_theme
delete_color_palette
delete_theme
get_color_palette
get_theme
list_color_palettes
list_themes
update_color_palette
update_theme
base
Base
from_dict
to_dict
JsonApiEntityBase
catalog_service_base
CatalogServiceBase
get_organization
layout_organization_folder
data_source
action_model
requests
ldm_request
CatalogGenerateLdmRequest
CatalogPdmLdmRequest
CatalogPdmSql
scan_model_request
CatalogScanModelRequest
scan_sql_request
ScanSqlRequest
responses
scan_sql_response
ScanSqlResponse
sql_column
SqlColumn
declarative_model
data_source
CatalogDeclarativeDataSource
to_test_request
CatalogDeclarativeDataSources
data_sources_folder
load_from_disk
store_to_disk
physical_model
column
CatalogDeclarativeColumn
pdm
CatalogDeclarativeTables
CatalogScanResultPdm
table
CatalogDeclarativeTable
entity_model
content_objects
data_source
_NoCredentials
CatalogDataSource
CatalogDataSourceBase
to_api_patch
CatalogDataSourceBigQuery
CatalogDataSourceDatabricks
CatalogDataSourceGdStorage
CatalogDataSourceGreenplum
CatalogDataSourceMariaDb
CatalogDataSourceMotherDuck
CatalogDataSourceMsSql
CatalogDataSourceMySql
CatalogDataSourcePostgres
CatalogDataSourceRedshift
CatalogDataSourceSnowflake
CatalogDataSourceVertica
DatabaseAttributes
DatabricksAttributes
GreenplumAttributes
MariaDbAttributes
MotherDuckAttributes
MsSqlAttributes
MySqlAttributes
PostgresAttributes
RedshiftAttributes
SnowflakeAttributes
VerticaAttributes
service
CatalogDataSourceService
analyze_csv
create_or_update_data_source
data_source_folder
delete_csv_files
delete_data_source
generate_logical_model
get_data_source
get_declarative_data_sources
import_csv
list_data_sources
load_and_put_declarative_data_sources
load_declarative_data_sources
load_pdm_from_disk
patch_data_source_attributes
put_declarative_data_sources
register_upload_notification
report_warnings
scan_data_source
scan_pdm_and_generate_logical_model
scan_schemata
scan_sql
staging_upload
store_declarative_data_sources
store_pdm_to_disk
test_data_sources_connection
upload_csv
validation
data_source
DataSourceValidator
validate_data_source_ids
validate_ldm
depends_on
CatalogDependsOn
CatalogDependsOnDateFilter
to_api
CatalogDependsOnDateFilterItem
entity
AttrCatalogEntity
from_api
BasicCredentials
CatalogEntity
ClientSecretCredentials
ClientSecretCredentialsFromFile
client_secret_from_file
Credentials
is_part_of_api
to_api_args
validate_instance
KeyPairCredentials
TokenCredentials
TokenCredentialsFromEnvVar
token_from_env_var
TokenCredentialsFromFile
token_from_file
export
request
ExportCustomLabel
ExportCustomMetric
ExportCustomOverride
ExportRequest
ExportSettings
SlidesExportRequest
VisualExportRequest
service
ExportService
export_pdf
export_slides
export_tabular
export_tabular_by_visualization_id
filter_by
CatalogFilterBy
client_class
identifier
CatalogAssigneeIdentifier
CatalogDatasetWorkspaceDataFilterIdentifier
CatalogDeclarativeAnalyticalDashboardIdentifier
CatalogDeclarativeUserGroupIdentifier
CatalogExportDefinitionIdentifier
CatalogFactIdentifier
CatalogGrainIdentifier
CatalogLabelIdentifier
CatalogNotificationChannelIdentifier
CatalogReferenceIdentifier
CatalogUserIdentifier
CatalogWorkspaceIdentifier
organization
common
dashboard_slides_template
CatalogDashboardSlidesTemplate
running_section
CatalogRunningSection
slide_template
CatalogContentSlideTemplate
CatalogCoverSlideTemplate
CatalogIntroSlideTemplate
CatalogSectionSlideTemplate
widget_slides_template
CatalogWidgetSlidesTemplate
entity_model
directive
CatalogCspDirective
init
CatalogCspDirectiveAttributes
export_template
CatalogExportTemplate
CatalogExportTemplateAttributes
identity_provider
CatalogIdentityProvider
CatalogIdentityProviderAttributes
CatalogIdentityProviderDocument
jwk
CatalogJwk
CatalogJwkAttributes
CatalogJwkDocument
CatalogRsaSpecification
llm_provider
CatalogAwsBedrockProviderConfig
CatalogAzureFoundryApiKeyAuth
CatalogAzureFoundryProviderConfig
CatalogBedrockAccessKeyAuth
CatalogLlmProvider
CatalogLlmProviderAttributes
CatalogLlmProviderDocument
CatalogLlmProviderModel
CatalogLlmProviderPatch
CatalogLlmProviderPatchAttributes
CatalogLlmProviderPatchDocument
CatalogOpenAiApiKeyAuth
CatalogOpenAiProviderConfig
organization
CatalogOrganization
CatalogOrganizationAttributes
CatalogOrganizationDocument
setting
CatalogOrganizationSetting
CatalogOrganizationSettingAttributes
layout
export_template
CatalogDeclarativeExportTemplate
identity_provider
CatalogDeclarativeIdentityProvider
notification_channel
CatalogDeclarativeNotificationChannel
CatalogWebhook
service
CatalogOrganizationService
create_csp_directive
create_identity_provider
create_llm_provider
create_or_update_export_template
create_or_update_jwk
create_organization_setting
delete_csp_directive
delete_export_template
delete_identity_provider
delete_jwk
delete_llm_provider
delete_organization_setting
get_csp_directive
get_declarative_export_templates
get_declarative_identity_providers
get_declarative_notification_channels
get_export_template
get_identity_provider
get_jwk
get_llm_provider
get_organization_setting
list_csp_directives
list_export_templates
list_identity_providers
list_jwks
list_llm_providers
list_organization_settings
patch_identity_provider_attributes
put_declarative_export_templates
put_declarative_identity_providers
put_declarative_notification_channels
switch_active_identity_provider
update_allowed_origins
update_csp_directive
update_identity_provider
update_llm_provider
update_name
update_organization_setting
parameter
CatalogParameter
to_data_source_parameter
permission
declarative_model
dashboard_assignees
CatalogAvailableAssignees
CatalogUserAssignee
CatalogUserGroupAssignee
dashboard_permissions
CatalogDashboardPermissions
CatalogGrantedPermission
CatalogRulePermission
CatalogUserGroupPermission
CatalogUserPermission
manage_dashboard_permissions
CatalogDashboardAssigneeIdentifier
CatalogPermissionsForAssigneeIdentifier
CatalogPermissionsForAssigneeRule
permission
CatalogDeclarativeDashboardPermissionsForAssignee
CatalogDeclarativeDashboardPermissionsForAssigneeRule
CatalogDeclarativeDataSourcePermission
CatalogDeclarativeOrganizationPermission
CatalogDeclarativeSingleWorkspacePermission
CatalogDeclarativeWorkspaceHierarchyPermission
CatalogDeclarativeWorkspacePermissions
CatalogOrganizationPermissionAssignment
service
CatalogPermissionService
get_declarative_organization_permissions
get_declarative_permissions
list_available_assignees
list_dashboard_permissions
manage_dashboard_permissions
manage_organization_permissions
put_declarative_organization_permissions
put_declarative_permissions
rule
CatalogAssigneeRule
setting
CatalogDeclarativeCustomApplicationSetting
CatalogDeclarativeSetting
types
user
declarative_model
user
CatalogDeclarativeUser
CatalogDeclarativeUserPermission
CatalogDeclarativeUsers
user_and_user_groups
CatalogDeclarativeUsersUserGroups
user_group
CatalogDeclarativeUserGroup
CatalogDeclarativeUserGroupPermission
CatalogDeclarativeUserGroups
entity_model
api_token
CatalogApiToken
user
CatalogUser
add_user_group
add_user_groups
remove_user_groups
replace_user_groups
CatalogUserAttributes
CatalogUserDocument
update_user
CatalogUserGroupsData
CatalogUserRelationships
create_user_relationships
user_group
CatalogUserGroup
CatalogUserGroupAttributes
CatalogUserGroupDocument
update_user_group
CatalogUserGroupParents
CatalogUserGroupRelationships
create_user_group_relationships
management_model
management
CatalogDataSourcePermissionAssignment
CatalogPermissionAssignments
CatalogPermissionsAssignment
CatalogWorkspacePermissionAssignment
service
CatalogUserService
assign_permissions_bulk
create_or_update_user
create_or_update_user_group
create_user_api_token
delete_user
delete_user_api_token
delete_user_group
get_declarative_user_groups
get_declarative_users
get_declarative_users_user_groups
get_user
get_user_api_token
get_user_group
get_user_group_permissions
get_user_permissions
list_user_api_tokens
list_user_groups
list_users
load_and_put_declarative_user_groups
load_and_put_declarative_users
load_and_put_declarative_users_user_groups
load_declarative_user_groups
load_declarative_users
load_declarative_users_user_groups
manage_user_group_permissions
manage_user_permissions
put_declarative_user_groups
put_declarative_users
put_declarative_users_user_groups
revoke_permissions_bulk
store_declarative_user_groups
store_declarative_users
store_declarative_users_user_groups
validate_by_item
CatalogValidateByItem
workspace
aac
content_service
CatalogWorkspaceContentService
compute_valid_objects
get_aggregated_facts_catalog
get_attributes_catalog
get_declarative_analytics_model
get_declarative_ldm
get_dependent_entities_graph
get_dependent_entities_graph_from_entry_points
get_facts_catalog
get_full_catalog
get_label_elements
get_labels_catalog
get_metrics_catalog
layout_workspace_folder
load_analytics_model_from_disk
load_and_put_declarative_analytics_model
load_and_put_declarative_ldm
load_declarative_analytics_model
load_declarative_ldm
load_ldm_from_disk
put_declarative_analytics_model
put_declarative_ldm
store_analytics_model_to_disk
store_declarative_analytics_model
store_declarative_ldm
store_ldm_to_disk
declarative_model
workspace
analytics_model
analytics_model
CatalogDeclarativeAnalyticalDashboard
structure_permissions
CatalogDeclarativeAnalyticalDashboardExtension
CatalogDeclarativeAnalytics
CatalogDeclarativeAnalyticsLayer
get_analytical_dashboard_extensions_folder
get_analytical_dashboards_folder
get_analytics_model_folder
get_attribute_hierarchy_folder
get_dashboard_plugins_folder
get_export_definition_folder
get_filter_contexts_folder
get_memory_item_folder
get_metrics_folder
get_visualization_objects_folder
CatalogDeclarativeAttributeHierarchy
CatalogDeclarativeDashboardPlugin
CatalogDeclarativeFilterContext
CatalogDeclarativeMemoryItem
CatalogDeclarativeMetric
CatalogDeclarativeVisualizationObject
base
CatalogAnalyticsBase
CatalogAnalyticsBaseMeta
CatalogAnalyticsObjectBase
export_definition
CatalogDeclarativeExportDefinition
CatalogDeclarativeExportDefinitionRequestPayload
automation
CatalogAutomationSchedule
CatalogAutomationTabularExport
CatalogAutomationVisualExport
CatalogDeclarativeAutomation
logical_model
data_filter_references
CatalogDeclarativeWorkspaceDataFilterReferences
dataset
dataset
CatalogDataSourceTableIdentifier
CatalogDeclarativeAggregatedFact
CatalogDeclarativeAttribute
CatalogDeclarativeDataset
CatalogDeclarativeDatasetSql
CatalogDeclarativeFact
CatalogDeclarativeLabel
CatalogDeclarativeLabelTranslation
CatalogDeclarativeReference
CatalogDeclarativeReferenceSource
CatalogDeclarativeSourceFactReference
CatalogDeclarativeWorkspaceDataFilterColumn
CatalogGeoAreaConfig
CatalogGeoCollectionIdentifier
dataset_extensions
dataset_extension
CatalogDeclarativeDatasetExtension
date_dataset
date_dataset
CatalogDeclarativeDateDataset
CatalogGranularitiesFormatting
ldm
CatalogDeclarativeLdm
change_tables_columns_case
create_dataset_extensions_folder
create_datasets_folder
create_date_instances_folder
create_ldm_folder
get_dataset_extensions_folder
get_datasets_folder
get_date_instances_folder
get_ldm_folder
modify_mapped_data_source
CatalogDeclarativeModel
workspace
CatalogDeclarativeFilterView
load_filter_views_from_disk
store_filter_views_to_disk
CatalogDeclarativeUserDataFilter
CatalogDeclarativeUserDataFilters
CatalogDeclarativeWorkspace
CatalogDeclarativeWorkspaceDataFilter
CatalogDeclarativeWorkspaceDataFilters
create_copy
CatalogDeclarativeWorkspaceDataFilterSetting
CatalogDeclarativeWorkspaceModel
change_wdf_refs_id
remove_wdf_refs
CatalogDeclarativeWorkspaces
filter_views_folder
user_data_filters_folder
workspace_data_filters_folder
workspaces_folder
entity_model
content_objects
dataset
CatalogAggregatedFact
CatalogAttribute
find_label
primary_label
CatalogDataset
filter_dataset
generate_attributes_from_api
CatalogFact
CatalogLabel
metric
CatalogMetric
as_computable
workspace_setting
CatalogWorkspaceSetting
filter_view
CatalogFilterView
assign_analytical_dashboard
clean_relationships
CatalogFilterViewAttributes
CatalogFilterViewDocument
CatalogFilterViewRelationships
create_user_analytical_dashboard_relationship
graph_objects
graph
CatalogDependentEntitiesGraph
CatalogDependentEntitiesNode
CatalogDependentEntitiesRequest
CatalogDependentEntitiesResponse
CatalogEntityIdentifier
user_data_filter
CatalogEntityIdentifier
CatalogUserDataFilter
assign_user
assign_user_group
clean_assignments
CatalogUserDataFilterAttributes
CatalogUserDataFilterDocument
to_post_api
CatalogUserDataFilterRelationships
create_user_user_group_relationship
workspace
CatalogWorkspace
model_container
CatalogWorkspaceContent
catalog_with_valid_objects
create_workspace_content_catalog
filter_by_valid_objects
find_label_attribute
get_dataset
get_metric
service
CatalogWorkspaceService
add_metadata_locale
add_title_description
add_title_description_tags
clean_metadata_localization
clone_workspace
create_custom_workspace_folder
create_or_update
create_or_update_filter_view
create_or_update_user_data_filter
create_or_update_workspace_setting
delete_filter_view
delete_user_data_filter
delete_workspace
delete_workspace_setting
generate_localized_workspaces
get_and_store_aac_workspace
get_declarative_automations
get_declarative_filter_views
get_declarative_user_data_filters
get_declarative_workspace
get_declarative_workspace_data_filters
get_declarative_workspaces
get_filter_view
get_metadata_localization
get_texts_to_translate
get_user_data_filter
get_workspace
get_workspace_setting
list_filters_views
list_user_data_filters
list_workspace_settings
list_workspaces
load_and_put_aac_workspace
load_and_put_declarative_filter_views
load_and_put_declarative_user_data_filters
load_and_put_declarative_workspace
load_and_put_declarative_workspace_data_filters
load_and_put_declarative_workspaces
load_declarative_filter_views
load_declarative_user_data_filters
load_declarative_workspace
load_declarative_workspace_data_filters
load_declarative_workspaces
provision_workspace_with_locales
put_declarative_automations
put_declarative_filter_views
put_declarative_user_data_filters
put_declarative_workspace
put_declarative_workspace_data_filters
put_declarative_workspaces
read_translation_file
resolve_all_workspace_settings
resolve_workspace_settings
save_metadata_locale_to_disk
set_metadata_locale_from_disk
set_metadata_localization
set_title_description
set_title_description_tags
set_translated_texts
store_declarative_filter_views
store_declarative_user_data_filters
store_declarative_workspace
store_declarative_workspace_data_filters
store_declarative_workspaces
translate_if_requested
translate_in_batches
sdk
GoodDataSdk
create
create_from_profile
Release Notes
aac
Type
Name