Learn
Learn
University
Community
Documentation
Support
Go to GoodData.com
Slack
All Products
Python SDK
Version (1.18)
dev
1.18
1.17
1.16
1.15
1.14
1.13
1.12
1.11
1.10
1.9
1.8
1.7
1.6
1.5
GitHub
Python SDK
Introduction
Installation
Getting Started
Pandas Overview
Administration
Organization
update_name
update_oidc_parameters
create_or_update_jwk
delete_jwk
get_jwk
list_jwks
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
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
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...
Users and User Groups
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
list_data_source_tables
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_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
Workspace
Workspaces
create_or_update
get_workspace
clone_workspace
delete_workspace
list_workspaces
get_declarative_workspaces
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...
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
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
col_to_attr_idx
col_to_metric_idx
index_to_attr_idx
dataframe
DataFrameFactory
for_exec_def
for_exec_result_id
for_insight
for_items
for_visualization
indexed
not_indexed
result_cache_metadata_for_exec_result_id
DataFrameMetadata
DefaultVisualizationColumnNaming
col_name_for_attribute
col_name_for_metric
good_pandas
GoodPandas
data_frames
sdk
series
SeriesFactory
indexed
not_indexed
result_convertor
_AccumulatedData
accumulate_data
accumulate_grand_totals
accumulate_headers
extend_existing_row_data
result
_DataWithHeaders
utils
AllPagedEntities
IndentDumper
analyze_scalar
anchor_node
ascend_resolver
check_empty_document
check_empty_mapping
check_empty_sequence
check_resolver_prefix
check_simple_key
choose_scalar_style
close
descend_resolver
determine_block_hints
dispose
emit
expect_alias
expect_block_mapping
expect_block_mapping_key
expect_block_mapping_simple_value
expect_block_mapping_value
expect_block_sequence
expect_block_sequence_item
expect_document_end
expect_document_root
expect_document_start
expect_first_block_mapping_key
expect_first_block_sequence_item
expect_first_document_start
expect_first_flow_mapping_key
expect_first_flow_sequence_item
expect_flow_mapping
expect_flow_mapping_key
expect_flow_mapping_simple_value
expect_flow_mapping_value
expect_flow_sequence
expect_flow_sequence_item
expect_node
expect_nothing
expect_scalar
expect_stream_start
flush_stream
generate_anchor
ignore_aliases
increase_indent
need_events
need_more_events
open
prepare_anchor
prepare_tag
prepare_tag_handle
prepare_tag_prefix
prepare_version
process_anchor
process_scalar
process_tag
represent
represent_binary
represent_bool
represent_data
represent_date
represent_datetime
represent_dict
represent_float
represent_int
represent_list
represent_mapping
represent_none
represent_scalar
represent_sequence
represent_set
represent_str
represent_undefined
represent_yaml_object
resolve
serialize
serialize_node
write_double_quoted
write_folded
write_indent
write_indicator
write_line_break
write_literal
write_plain
write_single_quoted
write_stream_end
write_stream_start
write_tag_directive
write_version_directive
ObjId
as_afm_id
as_afm_id_attribute
as_afm_id_dataset
as_afm_id_label
as_identifier
id
type
SideLoads
all_for_type
find
API Reference
catalog
base
AllPagedEntities
Base
client_class
to_api
to_dict
JsonApiEntityBase
client_class
to_api
to_dict
catalog_service_base
CatalogOrganization
client_class
to_api
to_dict
CatalogServiceBase
get_organization
layout_organization_folder
organization_id
data_source
action_model
requests
ldm_request
CatalogDeclarativeTable
client_class
store_to_disk
to_api
to_dict
CatalogGenerateLdmRequest
client_class
to_api
to_dict
CatalogPdmLdmRequest
client_class
to_api
to_dict
CatalogPdmSql
client_class
to_api
to_dict
SqlColumn
client_class
to_api
to_dict
scan_model_request
CatalogScanModelRequest
client_class
to_api
to_dict
scan_sql_request
ScanSqlRequest
client_class
to_api
to_dict
responses
scan_sql_response
ScanSqlResponse
client_class
to_api
to_dict
sql_column
declarative_model
physical_model
column
CatalogDeclarativeColumn
client_class
to_api
to_dict
pdm
CatalogDeclarativeTables
client_class
store_to_disk
to_api
to_dict
CatalogScanResultPdm
client_class
to_api
to_dict
table
entity_model
content_objects
service
CatalogDataSource
client_class
to_api
to_dict
url_template
CatalogDataSourceTable
client_class
to_api
to_dict
CatalogDeclarativeDataSource
client_class
data_source_folder
store_to_disk
to_api
to_dict
to_test_request
CatalogDeclarativeDataSources
client_class
data_sources_folder
store_to_disk
to_api
to_dict
CatalogDeclarativeModel
change_wdf_refs_id
client_class
remove_wdf_refs
store_to_disk
to_api
to_dict
TokenCredentialsFromFile
client_class
to_api
to_api_args
to_dict
token_from_file
validation
depends_on
AbsoluteDateFilter
apply_on_result
as_api_model
dataset
description
from_date
is_noop
to_date
CatalogDependsOn
client_class
to_api
to_dict
CatalogDependsOnDateFilter
to_api
CatalogDependsOnDateFilterItem
client_class
to_api
to_dict
RelativeDateFilter
apply_on_result
as_api_model
dataset
description
from_shift
granularity
is_noop
to_shift
entity
AttrCatalogEntity
client_class
json_api_attributes
json_api_related_entities_data
json_api_related_entities_side_loads
json_api_relationships
json_api_side_loads
obj_id
BasicCredentials
client_class
to_api
to_api_args
to_dict
CatalogEntity
description
id
obj_id
title
type
Credentials
client_class
to_api
to_api_args
to_dict
ObjId
as_afm_id
as_afm_id_attribute
as_afm_id_dataset
as_afm_id_label
as_identifier
id
type
TokenCredentials
client_class
to_api
to_api_args
to_dict
identifier
CatalogAssigneeIdentifier
client_class
to_api
to_dict
CatalogDatasetWorkspaceDataFilterIdentifier
client_class
to_api
to_dict
CatalogDeclarativeUserGroupIdentifier
client_class
to_api
to_dict
CatalogGrainIdentifier
client_class
to_api
to_dict
CatalogLabelIdentifier
client_class
to_api
to_dict
CatalogReferenceIdentifier
client_class
to_api
to_dict
CatalogUserIdentifier
client_class
to_api
to_dict
CatalogWorkspaceIdentifier
client_class
to_api
to_dict
organization
parameter
CatalogParameter
client_class
to_api
to_dict
permission
rule
CatalogAssigneeRule
client_class
to_api
to_dict
setting
CatalogDeclarativeCustomApplicationSetting
client_class
to_api
to_dict
CatalogDeclarativeSetting
client_class
to_api
to_dict
types
user
management_model
management
CatalogDataSourcePermissionAssignment
client_class
to_api
to_dict
CatalogPermissionAssignments
client_class
to_api
to_dict
CatalogPermissionsAssignment
client_class
to_api
to_dict
CatalogWorkspacePermissionAssignment
client_class
to_api
to_dict
validate_by_item
CatalogValidateByItem
client_class
to_api
to_dict
workspace
content_service
Attribute
as_api_model
has_same_label
label
local_id
show_all_values
CatalogAttribute
as_computable
client_class
dataset
find_label
granularity
json_api_attributes
json_api_related_entities_data
json_api_related_entities_side_loads
json_api_relationships
json_api_side_loads
labels
obj_id
primary_label
CatalogDeclarativeAnalytics
client_class
store_to_disk
to_api
to_dict
CatalogDependentEntitiesRequest
client_class
to_api
to_dict
CatalogDependentEntitiesResponse
client_class
to_api
to_dict
CatalogFact
as_computable
client_class
json_api_attributes
json_api_related_entities_data
json_api_related_entities_side_loads
json_api_relationships
json_api_side_loads
obj_id
CatalogLabel
as_computable
client_class
json_api_attributes
json_api_related_entities_data
json_api_related_entities_side_loads
json_api_relationships
json_api_side_loads
obj_id
primary
value_type
CatalogMetric
as_computable
client_class
format
json_api_attributes
json_api_related_entities_data
json_api_related_entities_side_loads
json_api_relationships
json_api_side_loads
obj_id
CatalogWorkspaceContent
attributes
catalog_with_valid_objects
datasets
date_attributes
facts
filter_by_valid_objects
find_label_attribute
get_dataset
get_metric
labels
metrics
standard_attributes
DataSourceValidator
validate_data_source_ids
validate_ldm
ExecutionDefinition
as_api_model
attributes
dimensions
filters
has_attributes
has_filters
has_metrics
is_one_dim
is_two_dim
metrics
Filter
apply_on_result
as_api_model
description
is_noop
Metric
as_api_model
local_id
model_container
CatalogDataset
client_class
dataset_type
filter_dataset
find_label_attribute
generate_attributes_from_api
generate_facts_from_api
json_api_attributes
json_api_related_entities_data
json_api_related_entities_side_loads
json_api_relationships
json_api_side_loads
obj_id
sdk
CatalogDataSourceService
create_or_update_data_source
data_source_folder
delete_data_source
generate_logical_model
get_data_source
get_declarative_data_sources
get_organization
layout_organization_folder
list_data_source_tables
list_data_sources
load_and_put_declarative_data_sources
load_declarative_data_sources
load_pdm_from_disk
organization_id
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
store_declarative_data_sources
store_pdm_to_disk
test_data_sources_connection
CatalogOrganizationService
create_csp_directive
create_or_update_jwk
create_organization_setting
delete_csp_directive
delete_jwk
delete_organization_setting
get_csp_directive
get_jwk
get_organization
get_organization_setting
layout_organization_folder
list_csp_directives
list_jwks
list_organization_settings
organization_id
update_allowed_origins
update_csp_directive
update_name
update_oidc_parameters
update_organization_setting
CatalogPermissionService
get_declarative_organization_permissions
get_declarative_permissions
get_organization
layout_organization_folder
list_available_assignees
list_dashboard_permissions
manage_dashboard_permissions
manage_organization_permissions
organization_id
put_declarative_organization_permissions
put_declarative_permissions
CatalogUserService
assign_permissions_bulk
create_or_update_user
create_or_update_user_group
delete_user
delete_user_group
get_declarative_user_groups
get_declarative_users
get_declarative_users_user_groups
get_organization
get_user
get_user_group
get_user_group_permissions
get_user_permissions
layout_organization_folder
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
organization_id
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
CatalogWorkspaceContentService
compute_valid_objects
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
get_organization
layout_organization_folder
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
organization_id
put_declarative_analytics_model
put_declarative_ldm
store_analytics_model_to_disk
store_declarative_analytics_model
store_declarative_ldm
store_ldm_to_disk
CatalogWorkspaceService
add_title_description
add_title_description_tags
clone_workspace
create_custom_workspace_folder
create_or_update
create_or_update_user_data_filter
create_or_update_workspace_setting
delete_user_data_filter
delete_workspace
delete_workspace_setting
generate_localized_workspaces
get_declarative_user_data_filters
get_declarative_workspace
get_declarative_workspace_data_filters
get_declarative_workspaces
get_organization
get_texts_to_translate
get_user_data_filter
get_workspace
get_workspace_setting
layout_organization_folder
list_user_data_filters
list_workspace_settings
list_workspaces
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_user_data_filters
load_declarative_workspace
load_declarative_workspace_data_filters
load_declarative_workspaces
organization_id
provision_workspace_with_locales
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
set_title_description
set_title_description_tags
set_translated_texts
store_declarative_user_data_filters
store_declarative_workspace
store_declarative_workspace_data_filters
store_declarative_workspaces
translate_if_requested
translate_in_batches
ComputeService
for_exec_def
retrieve_result_cache_metadata
ExportService
export_pdf
export_tabular
export_tabular_by_insight_id
export_tabular_by_visualization_id
get_organization
layout_organization_folder
organization_id
GoodDataApiClient
actions_api
custom_headers
entities_api
layout_api
user_management_api
GoodDataSdk
catalog_data_source
catalog_organization
catalog_permission
catalog_user
catalog_workspace
catalog_workspace_content
client
compute
export
insights
support
tables
visualizations
InsightService
get_insight
get_insights
get_visualization
get_visualizations
SupportService
is_available
wait_till_available
TableService
for_insight
for_items
for_visualization
VisualizationService
get_insight
get_insights
get_visualization
get_visualizations
Release Notes
IndentDumper.
emit
emit( ) -> None
Parameters
None
Returns
No docs
dispose
expect_alias