Working with embedded analytics - Amazon QuickSight

Working with embedded analytics

Important

Amazon QuickSight has new API operations for embedding analytics: GenerateEmbedUrlForAnonymousUser and GenerateEmbedUrlForRegisteredUser.

You can still use the GetDashboardEmbedUrl and GetSessionEmbedUrl API operations to embed dashboards and the QuickSight console, but they don't contain the latest embedding capabilities. For more information about embedding using the old API operations, see Embedding analytics using the GetDashboardEmbedURL and GetSessionEmbedURL API operations.

 Applies to: Enterprise Edition 
   Intended audience: Amazon QuickSight developers 

With embedded analytics from Amazon QuickSight, your users can perform advanced analytics on demand. By incorporating branded analytics into your web portals or applications, you provide interactive analytical tools without changing the user's context. Improving the user experience by reducing cognitive complexity gives users a better opportunity for deeper understanding and effectiveness.

QuickSight supports embedding for these elements:

  • QuickSight console (full authoring experience for registered users )

  • QuickSight dashboards and visuals (for registered users, anonymous users, public end users)

  • QuickSight Q search bar (for registered users and anonymous users)

With an embedded QuickSight console, you embed the full QuickSight experience. Doing this makes it possible to use QuickSight authoring tools as part of your application, rather than in the context of the AWS Management Console or a standalone website. Users of an embedded QuickSight console need to be registered as QuickSight authors or admins in your AWS account. They also need to be authenticated into the same AWS account, using any of the QuickSight-supported authentication methods.

With an embedded QuickSight dashboard or visual, readers get the same functionality and interactivity as they do in a published dashboard or visual. To use an embedded dashboard or visual, readers (viewers) can include any of the following:

  • QuickSight users authenticated in your AWS account by any method supported by QuickSight.

  • Unauthenticated visitors to a website or application – This option requires session packs with capacity pricing.

  • Multiple end users viewing a display on monitors or large screens by programmatic access.

If your app also resides in AWS, the app doesn't need to reside on the same AWS account as the QuickSight subscription. However, the app needs to be able to assume the AWS Identity and Access Management (IAM) role that you use for the API calls.

Before you can embed content, make sure that you're using QuickSight Enterprise edition in the AWS account where you plan to use embedding.

QuickSight embedding is available in all supported AWS Regions.