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()
      • Authentication
        • Authenticate
        • BasicAuthentication
        • ClientCertificate
        • OAuth2ResourceOwnerPasswordAuthentication
        • TokenAuthentication
      • ClientSideEncryptionConfig
      • Column
        • data_type
        • default_value
        • isin()
        • isnull()
        • name
      • Cube
        • aggregate_providers
        • aggregates_cache
        • create_date_hierarchy()
        • create_parameter_hierarchy_from_column()
        • create_parameter_hierarchy_from_members()
        • create_parameter_simulation()
        • hierarchies
        • levels
        • measures
        • name
        • query()
        • shared_context
      • Cubes
      • DirectQuery
        • Array conversion
        • ExternalColumn
        • ExternalDatabaseConnection
        • ExternalTable
        • ExternalTables
      • 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
        • dimension_default
        • isin()
        • name
        • slicing
        • virtual
        • visible
      • KeyPair
      • 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()
      • MdxQueryResult
        • style
      • Measure
        • data_type
        • description
        • folder
        • formatter
        • isnull()
        • name
        • visible
      • Measures
      • Level order
        • CustomOrder
        • NaturalOrder
      • Custom endpoint
        • HttpRequest
        • User
      • Aggregation scope
        • CumulativeScope
        • OriginScope
        • SiblingsScope
      • Security
        • BasicAuthenticationSecurity
        • DefaultRoles
        • IndividualRoles
        • KerberosSecurity
        • LdapSecurity
        • OidcSecurity
        • RoleMapping
        • Security
      • Session
        • add_external_table()
        • close()
        • connect
        • connect_to_external_database()
        • create_cube()
        • create_scenario()
        • create_table()
        • cubes
        • data_model_transaction()
        • delete_scenario()
        • endpoint()
        • export_translations_template()
        • link
        • logs_path
        • query_mdx()
        • read_arrow()
        • read_csv()
        • read_numpy()
        • read_pandas()
        • read_parquet()
        • read_spark()
        • read_sql()
        • ready
        • scenarios
        • security
        • start
        • tables
        • url
        • wait()
        • widget
      • Session config
        • BasicAuthenticationConfig
        • BrandingConfig
        • ClientCertificateConfig
        • HttpsConfig
        • I18nConfig
        • JwtConfig
        • KerberosConfig
        • LdapConfig
        • LoggingConfig
        • OidcConfig
        • SecurityConfig
        • SessionConfig
      • String functions
        • concat()
      • Table
        • append()
        • drop()
        • head()
        • join()
        • keys
        • load_arrow()
        • load_csv()
        • load_kafka()
        • load_numpy()
        • load_pandas()
        • load_parquet()
        • load_spark()
        • load_sql()
        • name
        • query()
        • row_count
        • scenario
        • scenarios
      • Tables
        • data_transaction()
        • schema
      • Data types
    • atoti-aws
      • Client side encryption
        • KeyPair
        • KmsConfig
    • atoti-azure
      • Client side encryption
        • KeyPair
    • atoti-directquery-bigquery
      • ConnectionConfig
      • TableConfig
    • atoti-directquery-clickhouse
      • ConnectionConfig
      • TableConfig
    • atoti-directquery-databricks
      • ConnectionConfig
      • TableConfig
    • atoti-directquery-jdbc
      • ConnectionConfig
      • TableConfig
    • atoti-directquery-mssql
      • ConnectionConfig
      • TableConfig
    • atoti-directquery-redshift
      • ConnectionConfig
      • TableConfig
    • atoti-directquery-snowflake
      • ConnectionConfig
      • TableConfig
    • atoti-directquery-synapse
      • ConnectionConfig
      • TableConfig
    • atoti-gcp
    • atoti-jdbc
      • Drivers
      • UserContentStorageConfig
    • atoti-kafka
    • atoti-jupyterlab
  • Reference
  • atoti.Session
  • atoti.Session.link

atoti.Session.link#

property Session.link: Link#

Link to the session.

Return it from a notebook code cell to display it.

  • If used inside JupyterLab with atoti-jupyterlab installed, the JupyterLab extension will try to reach the session in this order:

  1. Jupyter Server Proxy if it is enabled.

  2. f"{session_protocol}//{jupyter_server_hostname}:{session_port}".

  3. url.

  • If used in another environment, url wil be used.

When url is used and the session is running on another machine, the link may not be reachable. In that situation, the session may be reached from f"{public_ip_or_domain_of_machine_hosting_session}:{session_port}".

A path can be added to the link with /.

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