Looker

Developers

Starting June 2022, API 3.x is deprecated. Read our deprecation notice to see how this affects you.

Get started with embedding Looker

Knowledge check: This page assumes you understand the basics of Inline Frame HTML Element <iframe>, window.postMessage(), and Javascript. Check out the MDN web documentation on iframes and postmessaging to familiarize yourself with these concepts.

We provide options for you to embed Looker content in your host application via iframes. Each option differs in how you manage and interact with your iframe and authorize/authenticate your user. If you are not sure which option to start with, check out the suggested learning path at the end of this page.

Your iframe embedding options

Every option supports theming and can embed dashboards, LookML dashboards, Explores, Looks, query visualizations, and extensions.

Private embedding

  • You manage your iframe directly.
  • You may use window.postMessage() to interact with your iframe.
  • Your user must authenticate/authorize with Looker directly or with Looker via single sign-on (SSO) with an identity provider.

SSO embedding

  • You manage your iframe directly.
  • You may use window.postMessage() to interact with your iframe.
  • You generate a unique iframe src url for every embed user session. This one-time-use URL creates a new Looker embed user or updates an existing one.
  • You must authenticate/authorize the user outside of Looker, for example, through your host application’s identity provider via SSO.

SSO embedding with Embed SDK (Recommended)

  • You use the Embed SDK’s convenient Javascript API to manage and interact with your iframe.
  • You generate a unique URL for every embed user session. This one-time-use URL creates a new Looker embed user or updates an existing one. The Embed SDK helps automate part of the URL generation.
  • You must authenticate/authorize the user outside of Looker, for example, through your host application’s identity provider via SSO.

Suggested learning path

We suggest you get started in this order:

  1. Get started with private embedding for a basic understanding of Looker embedding.
  2. Get started with SSO embedding with Embed SDK to familiarize yourself with our Embed SDK and how to interact with your iframe.

API

OverviewGetting StartedInteractive ReferenceAdvanced UsageExamples & SamplesArticles & Tutorials

Embedding

OverviewGetting StartedEmbed SDKAdvanced EmbeddingTroubleshooting

Actions

OverviewGetting StartedWriting Custom ActionsExamples & Samples

Extensions

OverviewGetting StartedAPI ReferenceExamples & Samples

Components

OverviewGetting StartedDocumentation Visualization Components

Marketplace

OverviewGetting StartedVisit the MarketplaceCustom Viz BuilderArticles & Tutorials

Community

EventsForumsOpen Source

© 2023 Looker Data Sciences, Inc.
Privacy | Terms | Cookies