Skip to main content
Ctrl+K
Logo image

Site Navigation

  • Getting Started
  • Deployment
  • How to
  • Reference
  • Changelog

Site Navigation

  • Getting Started
  • Deployment
  • How to
  • Reference
  • Changelog
Ctrl+K

Section Navigation

  • API
    • atoti
      • Aggregation functions
        • count_distinct()
        • long()
        • max()
        • max_member()
        • mean()
        • median()
        • min()
        • min_member()
        • prod()
        • quantile()
        • short()
        • single_value()
        • square_sum()
        • std()
        • sum()
        • sum_product()
        • var()
      • AggregateProvider
      • AggregatesCache
        • capacity
      • App extensions
      • Array functions
        • len()
        • max()
        • mean()
        • min()
        • n_greatest()
        • n_greatest_indices()
        • n_lowest()
        • n_lowest_indices()
        • negative_values()
        • nth_greatest()
        • nth_lowest()
        • positive_values()
        • prefix_sum()
        • prod()
        • quantile()
        • quantile_index()
        • replace()
        • sort()
        • std()
        • sum()
        • var()
      • ClientSideEncryptionConfig
      • Column
        • data_type
        • default_value
        • isin()
        • isnull()
        • name
      • Session config
        • Authentication
        • BrandingConfig
        • ClientCertificateConfig
        • HttpsConfig
        • I18nConfig
        • JwtConfig
        • KeyPair
        • LoggingConfig
        • UserContentStorageConfig
      • Cube
        • aggregate_providers
        • aggregates_cache
        • create_date_hierarchy()
        • create_parameter_hierarchy_from_column()
        • create_parameter_hierarchy_from_members()
        • create_parameter_simulation()
        • explain_query()
        • hierarchies
        • levels
        • measures
        • name
        • query()
        • shared_context
      • CubeContext
      • Cubes
      • DirectQuery
        • AutoMultiColumnArrayConversion
        • ExternalTables
        • MultiColumnArrayConversion
        • MultiRowArrayConversion
      • Experimental features
        • Experimental aggregation functions
        • Experimental finance functions
        • Experimental statistics functions
      • General functions
        • at()
        • date_diff()
        • date_shift()
        • filter()
        • first()
        • last()
        • lookup()
        • parent_value()
        • rank()
        • shift()
        • switch()
        • total()
        • where()
      • Hierarchies
      • Hierarchy
        • dimension
        • isin()
        • levels
        • name
        • slicing
        • virtual
        • visible
      • Level
        • data_type
        • dimension
        • hierarchy
        • isin()
        • isnull()
        • name
        • order
      • Levels
      • Math functions
        • abs()
        • ceil()
        • cos()
        • erf()
        • erfc()
        • exp()
        • floor()
        • isnan()
        • log()
        • log10()
        • max()
        • min()
        • round()
        • sin()
        • sqrt()
        • tan()
      • Measure
        • data_type
        • description
        • folder
        • formatter
        • isnull()
        • name
        • visible
      • Measures
      • Level order
        • CustomOrder
        • NaturalOrder
      • Custom endpoints
        • HttpRequest
        • User
      • Aggregation scopes
        • CumulativeScope
        • OriginScope
        • SiblingsScope
      • Session
        • add_external_table()
        • close()
        • closed
        • connect_to_external_database()
        • create_cube()
        • create_scenario()
        • create_table()
        • cubes
        • delete_scenario()
        • endpoint()
        • explain_mdx_query()
        • export_translations_template()
        • link
        • logs_path
        • name
        • port
        • query_mdx()
        • read_arrow()
        • read_csv()
        • read_numpy()
        • read_pandas()
        • read_parquet()
        • read_spark()
        • read_sql()
        • ready
        • scenarios
        • security
        • start_transaction()
        • tables
        • wait()
        • widget
      • String functions
        • concat()
      • Table
        • append()
        • columns
        • drop()
        • head()
        • join()
        • keys
        • load_arrow()
        • load_csv()
        • load_kafka()
        • load_numpy()
        • load_pandas()
        • load_parquet()
        • load_spark()
        • load_sql()
        • name
        • query()
        • scenario
        • scenarios
      • Tables
        • schema
      • Data types
    • atoti-aws
      • Client side encryption
        • AwsKeyPair
        • AwsKmsConfig
    • atoti-azure
      • Client side encryption
        • AzureKeyPair
    • atoti-directquery-bigquery
      • BigqueryConnection
        • cache
        • tables
      • BigqueryConnectionInfo
      • BigqueryTable
        • columns
        • name
      • BigqueryTableOptions
    • atoti-directquery-clickhouse
      • ClickhouseConnection
        • cache
        • tables
      • ClickhouseConnectionInfo
      • ClickhouseTable
        • columns
        • name
      • ClickhouseTableOptions
    • atoti-directquery-databricks
      • DatabricksConnection
        • tables
      • DatabricksConnectionInfo
      • DatabricksTable
        • columns
        • name
      • DatabricksTableOptions
    • atoti-directquery-mssql
      • MsSqlConnection
        • tables
      • MsSqlConnectionInfo
      • MsSqlTable
        • columns
        • name
      • MsSqlTableOptions
    • atoti-directquery-redshift
      • RedshiftConnection
        • cache
        • tables
      • RedshiftConnectionInfo
      • RedshiftTable
        • columns
        • name
      • RedshiftTableOptions
    • atoti-directquery-snowflake
      • SnowflakeConnection
        • cache
        • tables
      • SnowflakeConnectionInfo
      • SnowflakeTable
        • columns
        • name
      • SnowflakeTableOptions
    • atoti-directquery-synapse
      • SynapseConnection
        • tables
      • SynapseConnectionInfo
      • SynapseTable
        • columns
        • name
      • SynapseTableOptions
    • atoti-gcp
    • atoti-jupyterlab
    • atoti-kafka
    • atoti-query
      • Auth
      • BasicAuthentication
      • ClientCertificate
      • OAuth2ResourceOwnerPasswordAuthentication
      • QueryCube
        • hierarchies
        • levels
        • measures
        • name
        • query()
      • QueryCubes
      • QueryHierarchies
      • QueryHierarchy
        • dimension
        • isin()
        • levels
        • name
        • slicing
      • QueryLevel
        • dimension
        • hierarchy
        • isin()
        • isnull()
        • name
      • QueryLevels
      • QueryMeasure
        • description
        • folder
        • formatter
        • isnull()
        • name
        • visible
      • QueryMeasures
      • QueryResult
        • style
      • QuerySession
        • cubes
        • link
        • query_mdx()
        • url
        • widget
      • Security
        • BasicSecurity
        • DefaultRoles
        • IndividualRoles
        • KerberosSecurity
        • LdapSecurity
        • OidcSecurity
        • RoleMapping
        • Security
      • TokenAuthentication
    • atoti-sql
      • Drivers
  • Reference
  • atoti.Session
  • atoti.Session.link

atoti.Session.link#

property Session.link: Link#

Display a link to this session.

If the atoti-jupyterlab plugin is:

  • not enabled, the session’s local URL will be used so the link may not be reachable if Atoti is running on another machine. In that situation, the session may be reached from f{public_ip_or_domain_of_machine_hosting_atoti}:{session.port} (see atoti.Session.port()).

  • enabled, the JupyterLab extension will try to access the session through (in this order):

    1. Jupyter Server Proxy if it is enabled.

    2. f"{session_protocol}//{jupyter_server_hostname}:{session.port}" for Session and session.url for QuerySession.

A path can be added to the linked URL with a /:

Example

Linking to an existing dashboard:

dashboard_id = "92i"
session.link / "#/dashboard/{dashboard_id}"

previous

atoti.Session.export_translations_template()

next

atoti.Session.logs_path

EULA Privacy policy Terms of Use Contact