• Developer guide
  • API reference

›Analytics

Getting started

  • Introduction to Imply Polaris
  • Quickstart
  • Execute a POC
  • Create a dashboard
  • Navigate the console
  • Key concepts

Tables and data

  • Overview
  • Introduction to tables
  • Table schema
  • Create an ingestion job
  • Timestamp expressions
  • Data partitioning
  • Introduction to rollup
  • Approximation algorithms
  • Replace data

Ingestion sources

  • Ingestion sources overview
  • Supported data formats
  • Create a connection
  • Ingest from files
  • Ingest data from a table
  • Ingest from S3
  • Ingest from Kafka and MSK
  • Ingest from Kinesis
  • Ingest from Confluent Cloud
  • Kafka Connector for Imply Polaris
  • Push event data
  • Connect to Confluent Schema Registry

Analytics

  • Overview
  • Manage data cubes
  • Visualize data
  • Data cube dimensions
  • Data cube measures
  • Dashboards
  • Visualizations reference
  • Set up alerts
  • Set up reports
  • Embed visualizations
  • Query data

Monitoring

  • Overview

Management

  • Overview
  • Pause and resume a project

Billing

  • Overview
  • Polaris plans
  • Estimate project costs

Usage

  • Overview

Security

    Polaris access

    • Overview
    • Invite users to your organization
    • Manage users
    • Permissions reference
    • Manage user groups
    • Enable SSO
    • SSO settings reference
    • Map IdP groups

    Secure networking

    • Connect to AWS
    • Create AWS PrivateLink connection

Developer guide

  • Overview
  • Authentication

    • Overview
    • Authenticate with API keys
    • Authenticate with OAuth
  • Manage users and groups
  • Migrate deprecated resources
  • Create a table
  • Define a schema
  • Upload files
  • Create an ingestion job
  • Ingestion sources

    • Ingest from files
    • Ingest from a table
    • Get ARN for AWS access
    • Ingest from Amazon S3
    • Ingest from Kafka and MSK
    • Ingest from Amazon Kinesis
    • Ingest from Confluent Cloud
    • Push event data
    • Kafka Connector for Imply Polaris
    • Kafka Connector reference
  • Filter data to ingest
  • Ingest nested data
  • Ingest and query sketches
  • Specify data schema
  • Query data
  • Update a project
  • Link to BI tools
  • Connect over JDBC
  • Query parameters reference
  • API documentation

    • OpenAPI reference
    • Query API

Product info

  • Release notes
  • Known limitations
  • Druid extensions

Embed visualizations

You can use the embedding feature in Imply Polaris to create links to read-only visualizations. You can share links or embed them in third-party apps to provide non-Polaris users with a way to view visualizations outside the Polaris UI.

The embedding feature also generates API specs that you can use to programmatically create embedded visualizations.

Prerequisites

Users with the AdministerEmbedLinks permission can configure embedding links in Polaris. For information on permissions, see Permissions reference.

Create an embedding link

Follow these steps to create an embedding link:

  1. Click Embedding in the left pane.

    embedding links page

    The page lists all embedding links created in the Polaris UI. Click the API generated tab to see links created with the Embedding API.

  2. Click New embedding link.

  3. To create a link to a data cube, select the data cube and click Configure view. You can add filters, dimensions and measures to restrict the data to include in the embedded view. Click Save when you've finished setting up the view.

    To create a link to a dashboard, select the dashboard and click Save.

  4. Complete the Embed View dialog:
    - Name: Enter a name for your embedding link.
    - Description: Enter an optional description.
    - Select Hide surrounding controls, show visualization only to hide the left navigation panel and header bar as shown below:

    hide controls


    - Access filter: You can optionally apply a SQL condition to the underlying data. See Create an access filter for more information.
    Click the API spec tab if you want to generate the link via API.

  5. Click Generate link when you've finished configuring the link.
    From the confirmation dialog you can preview the link in a new tab and copy the link to your clipboard.

To create an embedding link from a data cube:

  1. Go to the data cube page and click the alerts and reports ellipsis in the top right corner, then select Embed this view.

  2. Complete the Embed View dialog as outlined above, then generate the link.

To create an embedding link from a dashboard:

  1. Go to the dashboard page and click the embedding ellipsis in the top right corner, then select Embed this view.

  2. Complete the Embed View dialog as outlined above, then generate the link.

Manage access to embedding links

Once you create a link and share or embed it in a third-party app, anyone can access it and view all of its underlying data.

If you configure a data cube or dashboard to restrict access to specific Polaris users or groups, these restrictions don't apply to embedding links. A warning icon appears in Polaris when you create a link for a restricted data cube or dashboard.

You can, however, create an access filter to limit the data displayed by an embedding link. Access filters allow you to apply a SQL predicate to an embedded visualization's underlying data.

Create an access filter

You can create a single access filter for each embedding link. If you want to create multiple access filters for the same data cube or dashboard, create multiple links.

In the Access filters field for an embedding link, enter a SQL query to select data for the filter. Preface column names with t.—for example, t.cityName = 'Berlin' OR t.cityName = 'Munich' AND t.channel = '#de.wikipedia'.

Manage embedding links

Click Embedding in the left pane to manage embedding links.

For each link, you can:

  • Click the Copy icon to save the link to your clipboard.
  • Click the View details icon to view information about the link.
  • Click the open menu ellipsis to edit or delete the link.

Edit a link

Click the name of a link to edit its details:

embedding edit link

After you edit and save the link fields, you can click API call at the top of the page to view and copy the updated API request.

Embed a link

Once you have your embedding link or API request, you can use it to embed a webpage or app to provide read-only access to the visualization.

For example, you could embed a link in a webpage using an iframe tag as follows:

<iframe src="https://example.imply.io/e/9c45f08fa351bb9fc4" title="Example embedded visualization"></iframe>

Learn more

See the following topics for more information:

  • Manage data cubes for creating and editing data cubes.
  • Visualize data for using Polaris visualization features to draw insights from your data.
← Set up reportsQuery data →
  • Prerequisites
  • Create an embedding link
  • Manage access to embedding links
    • Create an access filter
  • Manage embedding links
    • Edit a link
  • Embed a link
  • Learn more
Key links
Try ImplyApache Druid siteImply GitHub
Get help
Stack OverflowSupportContact us
Learn more
BlogApache Druid docs
Copyright © 2023 Imply Data, Inc