Working with embedded analytics - Amazon QuickSight

Working with embedded analytics


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 do not 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 directly into your web portals or applications, you provide interactive analytical tools without changing the user's current context. Improving the user experience by reducing cognitive complexity gives users a better opportunity for deeper understanding and effectiveness.

QuickSight supports three types of embedding: one for the QuickSight console, one for QuickSight dashboards, and one for the QuickSight Q search bar. You can embed the full QuickSight experience to enable using QuickSight authoring tools as part of your application rather than in the context of the AWS Management Console or a standalone website. People who are using the QuickSight console or Q search bar through an embedded portal need to be registered as QuickSight authors or admins in your AWS account. They need to be authenticated into the same AWS account by any QuickSight-supported authentication methods. You can also embed interactive dashboards, which provide the same functionality as published dashboards. Viewers of embedded dashboards can include any of the following:

  • Unauthenticated visitors to a website or application – This option requires session packs with capacity pricing. For more information, see Pricing on the Amazon QuickSight website.

  • Programmatic access for display on large screens or monitors for consumption by multiple end users.

  • Any type of QuickSight users who are authenticated in your AWS account by any method supported by QuickSight.

Before you can embed content, make sure that you're using QuickSight Enterprise edition in the AWS account where you plan to use embedding. 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.

QuickSight embedding is available in all supported AWS Regions.