Embed a report

A public link to a report opens the report on its own, without the app around it: a slim header over the canvas, for an intranet page or a wall display. Anyone who has the link can open it, without signing in. Links are created and revoked on Share a report; this page covers what the link opens and how to run it unattended.

What the link opens

• A slim header sits above the canvas. From the left it shows the report's name (Untitled report when the report has none), then the active page's title and, under it, the question that page answers.
• On the right it carries its reading actions: Refresh, whose tooltip reads "Re-run every chart on this report"; Bookmarks, whose tooltip reads "Saved views of this report", when the report has bookmarks; Present, whose tooltip reads "Fill the screen for reading or a wall display"; and Documentation, whose tooltip reads Page documentation. On a narrow window they show their icons only, and the tooltip is the label.
• Bookmarks sits between Refresh and Present. It lists the report's bookmarks only: a visitor can apply them, but cannot keep bookmarks of their own or copy links. A bookmark navigator on the page and Present with bookmarks work too. See Bookmarks.
• The header is read-only: it carries no edit, share, export, subscribe, favourite or rename control. Documentation appears only when the page has notes, and the header is hidden while a present or wall-display session runs.
• It stays read-only: cross-filtering, slicers and drill all work, but nothing on the page can change the report.
• The charts run when the page opens, so a visitor starts from current numbers.
• Reports built on a model with row-level security cannot have public links. See Share a report.

Open the link without the header

Add ?header=0 to the link and the report opens as the canvas alone, with no header, for an iframe that brings its own chrome. Any other value for header, or no header at all, keeps the header.

Run the embed unattended (kiosk mode)

Add ?idle=1 to the end of the link, and a session starts by itself when the page opens: it reloads the numbers and turns the pages with no one at the keyboard.

• A value of 0 switches that half off: refresh=0 stops the chart reloads but keeps the pages turning, and dwell=0 keeps the screen on one page while the numbers keep reloading.
• A parameter you leave out keeps whatever cadence that screen used last; a screen that never ran a session starts at 60 seconds and 30 seconds.
• For example, ?idle=1&refresh=120&dwell=45 reloads the numbers every two minutes and turns the page every 45 seconds.
• Pages turn in the report's page order and wrap around after the last one. A report with a single page stays where it is.
• While the session runs, a control bar sits at the bottom: a countdown to the next change, Updated with the clock time the numbers last loaded, and controls to pause, turn the page, zoom or fill the screen. It dims after a few seconds and comes back when the pointer moves or a key is pressed. See Present and wall displays.

Open the embed on a specific page

Add ?page= to the embed link with the id of the page you want, and the report opens on that page. If the value is not one of the report's pages, the report opens on its first page.

Find the id in the report's own address in the app: open the report, turn to the page you want, and the address shows ?page= with that page's id (the first page is shown without it).

Add and arrange pages in edit mode; see Build a report.

Open the embed on a bookmark

Add ?bookmark= with a report bookmark's id to the embed link, and the report opens with that bookmark applied.

1. In the app, open Bookmarks in the report header and choose Copy link on the bookmark. Save the report first if the bookmark is new.
2. Take the bookmark= part from the end of the copied link and add it to the embed link: after ? when the embed link has no other parameter, after & when it has one.

If the bookmark no longer exists, the report opens as its author saved it, with a notice. Only report bookmarks work here: a visitor's own bookmarks and view links are not available on a public link. See Bookmarks.

When a link stops working

• Whether a link never existed, was revoked or has expired, it shows the same page: This link is not available, with "The embed link was revoked, has expired, or never existed. Ask the report's owner for a new one." The page does not say which case applies, and it shows no part of the report.
• While the link is checked and the report loads, the page shows Loading report.

Questions, answered

How do I make the embed run by itself on a screen?

Add ?idle=1 to the link. A session starts by itself when the page opens, reloading the numbers and turning the pages with no one at the keyboard.

Can I choose how often the embed refreshes and turns pages?

Yes. refresh sets how often the charts reload and dwell sets how long each page stays on screen before the next one turns in. Both take seconds in steps of 5, from 5 to 300, and a value of 0 switches that half off.

Can I keep the screen on one page?

Yes. Set dwell=0 so the pages stop turning, and add ?page= to open on the page you want; the numbers keep reloading on the refresh cadence.

Why is the embed not full screen when it starts?

A browser only goes full screen after a click, so a session that starts by itself stays within the browser window, with its tabs and address bar still in view. Press Fill the whole screen in the control bar on the screen itself, and the session uses the whole display.

What happens when I link to a page that no longer exists?

The embed opens the report on its first page. A ?page= value that is not one of the report's pages is ignored.

Why does the embed show "This link is not available"?

The link was revoked, has expired, or never existed. All three show the same page and it never says which one applies; ask the report's owner for a new link.

Do report changes show up on a screen that is already open?

Not while the page stays open. The embed loads the report when the page opens, and a running session reloads the numbers, not the layout. Reload the page to pick up changes.

How long does an embed keep working?

Until the link expires or someone revokes it. The expiry is chosen when the link is created, on Share a report.

Can the embed open on a bookmark or cycle bookmarks?

Yes. Add ?bookmark= with the bookmark's id, taken from Copy link on that bookmark in the app, and the embed opens with it applied. For a screen, ?idle=1&bookmarks=all cycles through the report's bookmarks instead of its pages.

Can I hide the header on the embed?

Yes. Add ?header=0 to the link, and the embed opens as the canvas alone for an iframe that brings its own chrome. Leave the parameter out, or give it any other value, and the header stays.