Looker Developer Portal content will be migrating to Google Cloud Docs

2. Retrieving data from the iframe

Retrieving data from the iframe

After completing the preparation steps, you can access the events passed between the Looker iframe and your domain by listening for postMessage events.

Please be sure to check that the events have come from the Looker iframe and domain to avoid malicious messages.

The embedded iframe can create a few event types, as described in the Event type reference section on this page.

Accessing events in JavaScript

Here is an example of listening for these events in native JavaScript, then logging them to the console:

window.addEventListener("message", function(event) {
  if (event.source === document.getElementById("looker").contentWindow) {
    if (event.origin === "https://instance_name.looker.com") {
      console.log(JSON.parse(event.data));
    }
  }
});

Here is an example of listening for these events in jQuery, then logging them to the console:

$(window).on("message", function(event) {
  if (event.originalEvent.source === $("#looker")[0].contentWindow) {
    if (event.origin === "https://instance_name.looker.com") {
      console.log(JSON.parse(event.data));
    }
  }
});

Event type summary table

The following table summarizes event types. Click on an event type to see the details about that event.

Event Type	Event Cause
`dashboard:loaded`	On dashboards where the tiles are not set to auto-run, a dashboard and its elements have loaded but queries are not yet running.
`dashboard:run:start`	A dashboard has begun loading, and its tiles have started loading and querying for data.
`dashboard:run:complete`	A dashboard has finished running and all tiles have finished loading and querying.
`dashboard:download`	A PDF of a dashboard has started downloading.
`dashboard:save:complete`	A dashboard has been edited and saved.
`dashboard:delete:complete`	A dashboard has been deleted.
`dashboard:tile:start`	A tile has started loading or querying for data.
`dashboard:tile:complete`	A tile has finished running the query.
`dashboard:tile:download`	A tile’s data has started downloading.
`dashboard:tile:explore`	A user has clicked the Explore From Here option in a dashboard tile.
`dashboard:tile:view`	A user has clicked the View Original Look option in a dashboard tile.
`dashboard:filters:changed`	A dashboard’s filters have been applied or changed.
`look:ready`	A Look has begun to load query data, whether the query will run or not.
`look:run:start`	A Look has begun to load query data and the query has begun to run.
`look:run:complete`	A Look has finished running the query.
`look:save:complete`	A Look has been edited and saved.
`look:delete:complete`	A Look has been moved into the Trash folder.
`drillmenu:click`	A user has clicked on a drill menu in a dashboard that was created with the `link` LookML parameter.
`drillmodal:download`	A user has opened a drill dialog box from a dashboard tile and clicked the Download option.
`drillmodal:explore`	A user has clicked the Explore From Here option in a drill dialog box.
`explore:ready`	An Explore has begun to load query data, whether the query will run or not.
`explore:run:start`	An Explore has begun to load query data and the query has begun to run.
`explore:run:complete`	An Explore has finished running the query.
`explore:state:changed`	An Explore page URL has changed as a result of the user’s actions.
`page:changed`	A user has navigated to a new page within the iframe.
`page:properties:changed`	The height of a dashboard iframe has changed.

Event type reference

The embedded iframe can create many different types of events:

`dashboard:loaded`

On dashboards where the tiles are not set to auto-run, this event is created after a dashboard and its elements have loaded but before queries are run.

The options attribute is not available on legacy dashboards.

type: "dashboard:loaded",
status: "complete",
dashboard: {
  id: 1,
  title: "Business Pulse",
  dashboard_filters: {
    "date": "Last 6 Years",
    "state": ""
  },
  absoluteUrl: "https://self-signed.looker.com:9999/embed/dashboards-next/1?embed_domain=https%3A%2F%2Fself-signed.looker.com%3A9999&date=Last+6+Years&state=",
  url: "/embed/dashboards-next/1?embed_domain=https%3A%2F%2Fself-signed.looker.com%3A9999&date=Last+6+Years&state=",
  options: {
    layouts: [
      {
        id: 1,
        dashboard_id: 1,
        type: "newspaper",
        active: true,
        column_width: null,
        width: null,
        deleted: false,
        dashboard_layout_components: [
          {
            id: 1,
            dashboard_layout_id: 1,
            dashboard_element_id: 1,
            row: 0,
            column: 0,
            width: 8,
            height: 4,
            deleted: false
          },
          {
            id: 2,
            dashboard_layout_id: 1,
            dashboard_element_id: 2,
            row: 0,
            column: 8,
            width: 8,
            height: 4,
            deleted: false
          }
        ]
      }
    ],
    elements: {
      1: {
        title: "Total Orders",
        title_hidden: false,
        vis_config: {
          type: "single_value",
          font_size: "medium",
          title: "Total Orders"
        }
      },
      2: {
        title: "Average Order Profit",
        title_hidden: false,
        vis_config: {
          type: "single_value",
          title: "Average Order Profit"
        }
      }
    }
  }
}

Attribute	Format	Description
`status`	String	Indicates whether the dashboard and its elements have successfully loaded.
`dashboard.id`	Number	The ID number of the dashboard.
`dashboard.title`	String	The title, as shown at the top of the dashboard.
`dashboard.dashboard_filters`	Object	The filters applied to the dashboard. This object has the format: `{"Filter name 1": "value 1", "Filter name 2": "value 2", ...}`
`dashboard.absoluteUrl`	String	The full dashboard URL.
`dashboard.url`	String	The relative dashboard URL (just the path).
`dashboard.options`	Object	The dashboard layout, dashboard layout component, and dashboard element properties and values. All properties returned in the `options` object can be given updated values using the `dashboard:options:set` event. This option is not available on legacy dashboards.

`dashboard:run:start`

This event is created when a dashboard has begun loading, when its tiles will start loading and querying for data.

type: "dashboard:run:start",
dashboard: {
  id: 23,
  title: "My Dashboard",
  url: "/embed/dashboards/...",
  absoluteUrl: "https://instance_name.looker.com/embed/dashboards/...",
  dashboard_filters: {
    "Date": "Last 28 days",
    "Total Orders": "Greater than 100"
  }
}

Attribute	Format	Description
`dashboard.id`	Number	The ID number of the dashboard.
`dashboard.url`	String	The relative dashboard URL (just the path).
`dashboard.absoluteUrl`	String	The full dashboard URL.
`dashboard.title`	String	The title, as shown at the top of the dashboard.
`dashboard.dashboard_filters`	Object	The filters applied to the dashboard. This object has the format: `{"Filter name 1": "value 1", "Filter name 2": "value 2", ...}`

`dashboard:run:complete`

This event is created when a dashboard has finished running and all tiles have finished loading and querying. This event is created whether or not all tiles load successfully.

The options attribute is not available on legacy dashboards.

type: "dashboard:run:complete",
status: "complete",
dashboard: {
  id: 23,
  title: "My Dashboard",
  url: "/embed/dashboards/...",
  absoluteUrl: "https://my.looker.com/embed/dashboards/...",
  dashboard_filters: {
    "Date": "Last 28 days",
    "Total Orders": "Greater than 100"
  }
  options: {
    layouts: [
      {
        id: 1,
        dashboard_id: 1,
        type: "newspaper",
        active: true,
        column_width: null,
        width: null,
        deleted: false,
        dashboard_layout_components: [
          {
            id: 1,
            dashboard_layout_id: 1,
            dashboard_element_id: 1,
            row: 0,
            column: 0,
            width: 8,
            height: 4,
            deleted: false
          },
          {
            id: 2,
            dashboard_layout_id: 1,
            dashboard_element_id: 2,
            row: 0,
            column: 8,
            width: 8,
            height: 4,
            deleted: false
          }
        ]
      }
    ],
    elements: {
      1: {
        title: "Total Orders",
        title_hidden: false,
        vis_config: {
          type: "single_value",
          font_size: "medium",
          title: "Total Orders"
        }
      },
      2: {
        title: "Average Order Profit",
        title_hidden: false,
        vis_config: {
          type: "single_value",
          title: "Average Order Profit"
        }
      }
    }
  }
}

Attribute	Format	Description
`status`	String	Indicates whether the dashboard and its elements have successfully run. If the dashboard and its elements were successfully run, `status` returns `"complete"`; otherwise, `status` returns `"error"`. If the running dashboard was stopped, either from the user interface or with the `dashboard:stop` action, `status` will return `"stopped"`.
`dashboard.id`	Number	The ID number of the dashboard.
`dashboard.url`	String	The relative dashboard URL (just the path).
`dashboard.absoluteUrl`	String	The full dashboard URL.
`dashboard.title`	String	The title, as shown at the top of the dashboard.
`dashboard.dashboard_filters`	Object	The filters applied to the dashboard. This object has the format: `{"Filter name 1": "value 1", "Filter name 2": "value 2", ...}`
`dashboard.options`	Object	The dashboard layout, dashboard layout component, and dashboard element properties and values. All properties returned in the `options` object can be given updated values using the `dashboard:options:set` action. This option is not available on legacy dashboards.

`dashboard:download`

This event is created when a PDF of a dashboard has started downloading.

type: "dashboard:download",
dashboard: {
  id: 23,
  title: "My Dashboard",
  url: "/embed/dashboards/...",
  absoluteUrl: "https://instance_name.looker.com/embed/dashboards/...",
  dashboard_filters: {
    "Date": "Last 28 days",
    "Total Orders": "Greater than 100"
  }
}
fileFormat: "pdf"

Attribute	Format	Description
`dashboard.id`	Number	The ID number of the dashboard.
`dashboard.url`	String	The relative dashboard URL (just the path).
`dashboard.absoluteUrl`	String	The full dashboard URL.
`dashboard.title`	String	The dashboard title, as shown at the top of the dashboard.
`dashboard.dashboard_filters`	Object	The filters applied to the dashboard. This object has the format: `{"Filter name 1": "value 1", "Filter name 2": "value 2", ...}`
`fileFormat`	String	The format of the downloaded dashboard (only `"pdf"` at this time).

`dashboard:save:complete`

This event is created when a dashboard is edited and then saved.

This event is not available on legacy dashboards.

type: "dashboard:save:complete",
dashboard: {
  id: 23,
  title: "My Dashboard",
  dashboard_filters: {
    "Date": "Last 28 days",
    "Total Orders": "Greater than 100"
  }
  absoluteUrl: "https://instance_name.looker.com/embed/dashboards/...",
  url: "/embed/dashboards/...",
  options: {
    layouts: [
      {
        id: 1,
        dashboard_id: 1,
        type: "newspaper",
        active: true,
        column_width: null,
        width: null,
        deleted: false,
        dashboard_layout_components: [
          {
            id: 1,
            dashboard_layout_id: 1,
            dashboard_element_id: 1,
            row: 0,
            column: 0,
            width: 8,
            height: 4,
            deleted: false
          },
          {
            id: 2,
            dashboard_layout_id: 1,
            dashboard_element_id: 2,
            row: 0,
            column: 8,
            width: 8,
            height: 4,
            deleted: false
          }
        ]
      }
    ],
    elements: {
      1: {
        title: "Total Orders",
        title_hidden: false,
        vis_config: {
          type: "single_value",
          font_size: "medium",
          title: "Total Orders"
        }
      },
      2: {
        title: "Average Order Profit",
        title_hidden: false,
        vis_config: {
          type: "single_value",
          title: "Average Order Profit"
        }
      }
    }
  }
}

Attribute	Format	Description
`dashboard.id`	Number	The ID number of the dashboard.
`dashboard.title`	String	The title, as shown at the top of the dashboard.
`dashboard.dashboard_filters`	Object	The filters applied to the dashboard. This object has the format: `{"Filter name 1": "value 1", "Filter name 2": "value 2", ...}`
`dashboard.absoluteUrl`	String	The full dashboard URL.
`dashboard.url`	String	The relative dashboard URL (just the path).
`dashboard.options`	Object	The dashboard layout, dashboard layout component, and dashboard element properties and values. All properties returned in the `options` object can be given updated values using the `dashboard:options:set` event.

`dashboard:delete:complete`

This event is created when a dashboard is deleted.

This event is not available on legacy dashboards.

type: "dashboard:delete:complete",
dashboard: {
  id: 23,
  title: "My Dashboard",
  dashboard_filters: {
    "Date": "Last 28 days",
    "Total Orders": "Greater than 100"
  }
  absoluteUrl: "https://instance_name.looker.com/embed/dashboards/...",
  url: "/embed/dashboards/...",
  options: {
    layouts: [
      {
        id: 1,
        dashboard_id: 1,
        type: "newspaper",
        active: true,
        column_width: null,
        width: null,
        deleted: false,
        dashboard_layout_components: [
          {
            id: 1,
            dashboard_layout_id: 1,
            dashboard_element_id: 1,
            row: 0,
            column: 0,
            width: 8,
            height: 4,
            deleted: false
          },
          {
            id: 2,
            dashboard_layout_id: 1,
            dashboard_element_id: 2,
            row: 0,
            column: 8,
            width: 8,
            height: 4,
            deleted: false
          }
        ]
      }
    ],
    elements: {
      1: {
        title: "Total Orders",
        title_hidden: false,
        vis_config: {
          type: "single_value",
          font_size: "medium",
          title: "Total Orders"
        }
      },
      2: {
        title: "Average Order Profit",
        title_hidden: false,
        vis_config: {
          type: "single_value",
          title: "Average Order Profit"
        }
      }
    }
  }
}

Attribute	Format	Description
`dashboard.id`	Number	The ID number of the dashboard.
`dashboard.title`	String	The title, as shown at the top of the dashboard.
`dashboard.dashboard_filters`	Object	The filters applied to the dashboard. This object has the format: `{"Filter name 1": "value 1", "Filter name 2": "value 2", ...}`
`dashboard.absoluteUrl`	String	The full dashboard URL.
`dashboard.url`	String	The relative dashboard URL (just the path).
`dashboard.options`	Object	The dashboard layout, dashboard layout component, and dashboard element properties and values. All properties returned in the `options` object can be given updated values using the `dashboard:options:set` event.

`dashboard:tile:start`

This event is created when a tile starts loading or querying for data.

type: "dashboard:tile:start",
dashboard: {
  id: 23,
  title: "My Dashboard",
  url: "/embed/dashboards/...",
  absoluteUrl: "https://instance_name.looker.com/embed/dashboards/...",
  dashboard_filters: {
    "Date": "Last 28 days",
    "Total Orders": "Greater than 100"
  }
}
tile: {
  id: 123,
  title: "Quarterly Sales",
  listen: {
    "Date": "order.date",
    "Total Orders": "order.count"
  }
}

Attribute	Format	Description
`dashboard.id`	Number	The ID number of the dashboard to which the tile belongs.
`dashboard.url`	String	The relative dashboard URL (just the path) to which the tile belongs.
`dashboard.absoluteUrl`	String	The full dashboard URL to which the tile belongs.
`dashboard.title`	String	The dashboard title, as shown at the top of the dashboard to which the tile belongs.
`dashboard.dashboard_filters`	Object	The filters applied to the dashboard to which the tile belongs. This object has the format: `{"Filter name 1": "value 1", "Filter name 2": "value 2", ...}`
`tile.id`	Integer	The ID number of the event, not the tile.
`tile.title`	String	The tile title, as shown at the top of the tile.
`tile.listen`	Object	The global dashboard filters this tile is listening for. This object has the format: `{"Filter Label": "Filter Field", ...}`

`dashboard:tile:complete`

This event is created when a tile has finished running the query.

type: "dashboard:tile:complete",
dashboard: {
  id: 23,
  title: "My Dashboard",
  url: "/embed/dashboards/...",
  absoluteUrl: "https://instance_name.looker.com/embed/dashboards/...",
  dashboard_filters: {
    "Date": "Last 28 days",
    "Total Orders": "Greater than 100"
  }
}
status: "complete",
truncated: false,
tile: {
  id: 123,
  title: "Quarterly Sales",
  listen: {
    "Date": "order.date",
    "Total Orders": "order.count"
  }
}

Attribute	Format	Description
`dashboard.id`	Number	The ID number of the dashboard to which the tile belongs.
`dashboard.url`	String	The relative dashboard URL (just the path) to which the tile belongs.
`dashboard.absoluteUrl`	String	The full dashboard URL to which the tile belongs.
`dashboard.title`	String	The dashboard title, as shown at the top of the dashboard to which the tile belongs.
`dashboard.dashboard_filters`	Object	The filters applied to the dashboard to which the tile belongs. This object has the format: `{"Filter name 1": "value 1", "Filter name 2": "value 2", ...}`
`status`	String	Whether the tile query completed successfully. Possible values are `"complete"` or `"error"`.
`truncated`	Boolean	Whether the tile query results were truncated as a result of the query returning more rows than the query row limit. The row limit could be either a user-specified row limit or the Looker default row limit of 5,000 rows.
`tile.id`	Integer	The ID number of the event, not the tile.
`tile.title`	String	The tile title, as shown at the top of the tile.
`tile.listen`	Object	The global dashboard filters this tile is listening for. This object has the format: `{"Filter Label": "Filter Field", ...}`

`dashboard:tile:download`

This event is created when a tile's data has started downloading.

type: "dashboard:tile:download",
dashboard: {
  id: 23,
  title: "My Dashboard",
  url: "/embed/dashboards/...",
  absoluteUrl: "https://instance_name.looker.com/embed/dashboards/...",
  dashboard_filters: {
    "Date": "Last 28 days",
    "Total Orders": "Greater than 100"
  }
}
tile: {
  id: 123,
  title: "Quarterly Sales"
  listen: {
    "Date": "order.date",
    "Total Orders": "order.count"
  }
}
fileFormat: "pdf"

Attribute	Format	Description
`dashboard.id`	Number	The ID number of the dashboard to which the tile belongs.
`dashboard.url`	String	The relative dashboard URL (just the path) to which the tile belongs.
`dashboard.absoluteUrl`	String	The full dashboard URL to which the tile belongs.
`dashboard.title`	String	The dashboard title, as shown at the top of the dashboard to which the tile belongs.
`dashboard.dashboard_filters`	Object	The filters applied to the dashboard to which the tile belongs. This object has the format: `{"Filter name 1": "value 1", "Filter name 2": "value 2", ...}`
`tile.id`	Integer	The ID number of the event, not the tile.
`tile.title`	String	The tile title, as shown at the top of the tile.
`tile.listen`	Object	The global dashboard filters this tile is listening for. This object has the format: `{"Filter Label": "Filter Field", ...}`
`fileFormat`	String	The format of the downloaded tile (only `"pdf"` at this time).

`dashboard:tile:explore`

This event is created when a user clicks the Explore From Here option in a dashboard tile.

type: "dashboard:tile:explore",
label: 'Explore From Here',
url: '/embed/explore/model/view...',
dashboard: {
  id: 23,
  title: "My Dashboard",
  url: "/embed/dashboards/...",
  absoluteUrl: "https://instance_name.looker.com/embed/dashboards/...",
  dashboard_filters: {
    "Date": "Last 28 days",
    "Total Orders": "Greater than 100"
  }
}
tile: {
  id: 123,
  title: "Quarterly Sales",
  listen: {
    "Date": "order.date",
    "Total Orders": "order.count"
  }
}

Attribute	Format	Description
`label`	String	The button label.
`url`	String	The relative URL (just the path) of the Explore to be viewed.
`dashboard.id`	Number	The ID number of the dashboard to which the tile belongs.
`dashboard.url`	String	The relative dashboard URL (just the path) to which the tile belongs.
`dashboard.absoluteUrl`	String	The full dashboard URL to which the tile belongs.
`dashboard.title`	String	The dashboard title, as shown at the top of the dashboard to which the tile belongs.
`dashboard.dashboard_filters`	Object	The filters applied to the dashboard to which the tile belongs. This object has the format: `{"Filter name 1": "value 1", "Filter name 2": "value 2", ...}`
`tile.id`	Integer	The ID number of the event, not the tile.
`tile.title`	String	The tile title, as shown at the top of the tile.
`tile.listen`	Object	The global dashboard filters this tile is listening for. This object has the format: `{"Filter Label": "Filter Field", ...}`

`dashboard:tile:view`

This event is created when a user clicks the View Original Look option in a dashboard tile.

type: "dashboard:tile:view",
label: 'View Original Look',
url: '/embed/look/...',
dashboard: {
  id: 23,
  title: "My Dashboard",
  url: "/embed/dashboards/...",
  absoluteUrl: "https://instance_name.looker.com/embed/dashboards/...",
  dashboard_filters: {
    "Date": "Last 28 days",
    "Total Orders": "Greater than 100"
  }
}
tile: {
  id: 123,
  title: "Quarterly Sales",
  listen: {
    "Date": "order.date",
    "Total Orders": "order.count"
  }
}

Attribute	Format	Description
`label`	String	The button label.
`url`	String	The relative URL (just the path) of the Look to be viewed.
`dashboard.id`	Number	The ID number of the dashboard to which the tile belongs.
`dashboard.url`	String	The relative dashboard URL (just the path) to which the tile belongs.
`dashboard.absoluteUrl`	String	The full dashboard URL to which the tile belongs.
`dashboard.title`	String	The dashboard title, as shown at the top of the dashboard to which the tile belongs.
`dashboard.dashboard_filters`	Object	The filters applied to the dashboard to which the tile belongs. This object has the format: `{"Filter name 1": "value 1", "Filter name 2": "value 2", ...}`
`tile.id`	Integer	The ID number of the event, not the tile.
`tile.title`	String	The tile title, as shown at the top of the tile.
`tile.listen`	Object	The global dashboard filters this tile is listening for. This object has the format: `{"Filter Label": "Filter Field", ...}`

`dashboard:filters:changed`

This event is created when a dashboard's filters have been applied or changed.

The options attribute is not available on legacy dashboards.

type: "dashboard:filters:changed",
dashboard: {
  id: 23,
  title: "My Dashboard",
  url: "/embed/dashboards/...",
  absoluteUrl: "https://instance_name.looker.com/embed/dashboards/...",
  dashboard_filters: {
    "Date": "Last 28 days",
    "Total Orders": "Greater than 100"
  }
  options: {
    layouts: [
      {
        id: 1,
        dashboard_id: 1,
        type: "newspaper",
        active: true,
        column_width: null,
        width: null,
        deleted: false,
        dashboard_layout_components: [
          {
            id: 1,
            dashboard_layout_id: 1,
            dashboard_element_id: 1,
            row: 0,
            column: 0,
            width: 8,
            height: 4,
            deleted: false
          },
          {
            id: 2,
            dashboard_layout_id: 1,
            dashboard_element_id: 2,
            row: 0,
            column: 8,
            width: 8,
            height: 4,
            deleted: false
          }
        ]
      }
    ],
    elements: {
      1: {
        title: "Total Orders",
        title_hidden: false,
        vis_config: {
          type: "single_value",
          font_size: "medium",
          title: "Total Orders"
        }
      },
      2: {
        title: "Average Order Profit",
        title_hidden: false,
        vis_config: {
          type: "single_value",
          title: "Average Order Profit"
        }
      }
    }
  }
}

Attribute	Format	Description
`dashboard.id`	Number	The ID number of the dashboard.
`dashboard.url`	String	The relative dashboard URL (just the path).
`dashboard.absoluteUrl`	String	The full dashboard URL.
`dashboard.title`	String	The title, as shown at the top of the dashboard.
`dashboard.dashboard_filters`	Object	The filters applied to the dashboard. This object has the format: `{"Filter name 1": "value 1", "Filter name 2": "value 2", ...}`
`dashboard.options`	Object	The dashboard layout, dashboard layout component, and dashboard element properties and values. All properties returned in the `options` object can be given updated values using the `dashboard:options:set` event. This option is not available on legacy dashboards.

`look:ready`

This event is created when a Look begins to load query data, whether the query runs or not.

type: "look:ready",
look: {
  url: "/embed/looks/...",
  absoluteUrl: "https://instance_name.looker.com/embed/looks/...",
  }
}

Attribute	Format	Description
`look.url`	String	The relative Look URL (just the path)
`look.absoluteUrl`	String	The full Look URL

`look:run:start`

This event is created when a Look begins to load query data and the query begins to run.

type: "look:run:start",
look: {
  url: "/embed/looks/...",
  absoluteUrl: "https://instance_name.looker.com/embed/looks/...",
  }
}

Attribute	Format	Description
`look.url`	String	The relative Look URL (just the path)
`look.absoluteUrl`	String	The full Look URL

`look:run:complete`

This event is created when a Look has finished running the query.

type: look:run:complete
look: {
  url: "/embed/looks/...",
  absoluteUrl: "https://instance_name.looker.com/embed/looks/...",
  }
}

Attribute	Format	Description
`look.url`	String	The relative Look URL (just the path)
`look.absoluteUrl`	String	The full Look URL

`look:save:complete`

This event is created when a Look is edited and saved. This event is created when a user performs one of the following tasks:

Clicks the Edit button to edit the Look and then clicks Save
Saves a Look with the Save As… menu option
Moves a Look from one folder to another

This event is not created if the Look is saved with the Save to Dashboard… or Edit Settings menu option.

type: look:save:complete
look: {
  url: "/embed/looks/...",
  absoluteUrl: "https://instance_name.looker.com/embed/looks/...",
  spaceId: 123
  }
}

Attribute	Format	Description
`look.url`	String	The relative Look URL (just the path)
`look.absoluteUrl`	String	The full Look URL
`look.spaceID`	Integer	The folder ID where the Look is stored

`look:delete:complete`

This event is created when a Look is moved to the Trash folder.

type: look:delete:complete
look: {
  url: "/embed/looks/...",
  absoluteUrl: "https://instance_name.looker.com/embed/looks/...",
  }
}

Attribute	Format	Description
`look.url`	String	The relative Look URL (just the path)
`look.absoluteUrl`	String	The full Look URL

`drillmenu:click`

This event is created when a user clicks on a drill menu in a dashboard created with the link LookML parameter. For example, the following LookML creates a drill menu where a user can view data filtered by the state dimension:

dimension: state {
  type: string
  sql: ${TABLE}.state ;;
  link: {
    label: "Filter by &#123;&#123; state | encode_uri &#125;&#125;"
    url: "filter::q=&#123;&#123; state | encode_uri &#125;&#125;"
    icon_url: "https://google.com/favicon.ico"
  }
}

When the state filter is set to Illinois, the drillmenu:click event returns the following to the host of the iframe:

type: "drillmenu:click",
label: "Filter by Illinois",
link_type: "url",
modal: false,
target: '_self',
url: "#filter::state=Illinois"
context: ' '

Attribute	Format	Description
`label`	String	The link label as shown on the drill menu
`link_type`	String	The type of object at the link destination
`modal`	Boolean	Whether the drill dialog box will be used instead of browser navigation
`target`	String	Is `_self` if the link destination will replace the current iframe, `_blank` if the link destination will open a new window
`url`	String	The URL of the link destination
`context`	String	Internal attribute used by some types of visualizations

Sandboxing the iframe will prevent drill menu clicks from opening in a new window. Use these sandboxing values inside the iframe tag:

sandbox = "allow-same-origin allow-scripts"

`drillmodal:download`

This event is created when a user opens a drill dialog box from a dashboard tile and clicks the Download option.

{
type: "drillmodal:download",
dashboard: {
  id: 23,
  title: "My Dashboard",
  url: "/embed/dashboards/…",
  absoluteUrl: "https://instance_name.looker.com/embed/dashboards/…",
  dashboard_filters: {
    "Date": "Last 28 days",
    "Total Orders": "Greater than 100"
  }
}
drillExploreUrl: "/embed...",
fileFormat: "pdf"
}

Attribute	Format	Description
`dashboard.id`	Number	The ID number of the dashboard to which the tile belongs.
`dashboard.title`	String	The dashboard title, as shown at the top of the dashboard to which the tile belongs.
`dashboard.url`	String	The relative dashboard URL (just the path) to which the tile belongs.
`dashboard.absoluteUrl`	String	The full dashboard URL to which the tile belongs.
`dashboard.dashboard_filters`	Object	The filters applied to the dashboard to which the tile belongs. This object has the format: `{"Filter name 1": "value 1", "Filter name 2": "value 2", ...}`
`drillExploreUrl`	String	The relative Explore URL (just the path) to be downloaded.
`fileFormat`	String	The file format of the data download.

`drillmodal:explore`

This event is created when a user clicks the Explore From Here option in a drill dialog box.

type: "drillmodal:explore",
label: "Explore From Here",
url: "/embed/explore/model/view..."

Attribute	Format	Description
`label`	String	The button label as shown on the drill menu
`url`	String	The relative Explore URL (just the path) to be viewed

`explore:ready`

This event is created when an Explore begins to load query data, whether the query runs or not.

type: "explore:ready",
explore: {
  url: "/embed/explore/...",
  absoluteUrl: "https://instance_name.looker.com/embed/explore/...",
  }
}

Attribute	Format	Description
`explore.url`	String	The relative Explore URL (just the path)
`explore.absoluteUrl`	String	The full Explore URL

`explore:run:start`

This event is created when an Explore begins to load query data and the query begins to run.

type: "explore:run:start",
explore: {
  url: "/embed/explore/...",
  absoluteUrl: "https://instance_name.looker.com/embed/explore/...",
  }
}

Attribute	Format	Description
`explore.url`	String	The relative Explore URL (just the path)
`explore.absoluteUrl`	String	The full Explore URL

`explore:run:complete`

This event is created when an Explore has finished running the query.

type: "explore:run:complete",
explore: {
  url: "/embed/explore/...",
  absoluteUrl: "https://instance_name.looker.com/embed/explore/...",
  }
}

Attribute	Format	Description
`explore.url`	String	The relative Explore URL (just the path)
`explore.absoluteUrl`	String	The full Explore URL

`explore:state:changed`

This event is created when an Explore page URL changes as a result of the user's actions.

type: "explore:state:changed",
explore: {
  url: "/embed/explore/...",
  absoluteUrl: "https://instance_name.looker.com/embed/explore/..."
}

Attribute	Format	Description
`explore.url`	String	The relative Explore URL (just the path)
`explore.absoluteUrl`	String	The full Explore URL

`page:changed`

This event is created when a user navigates to a new page within the iframe.

type: "page:changed",
page: {
  type: "dashboard",
  url: "/embed/dashboards/...",
  absoluteUrl: "https://instance_name.looker.com/embed/dashboards/..."
}

Attribute	Format	Description
`page.type`	String	The type of page that has just been navigated to, such as `"dashboard"`, `"look"`, or `"explore"`
`page.url`	String	The relative URL (just the path) of the page that has just been navigated to
`page.absoluteUrl`	String	The full URL of the page that has just been navigated to

`page:properties:changed`

This event is created when the height of a dashboard iframe changes. It is not available for Looks or Explores because those items automatically adjust their height to the size of the iframe.

type: "page:properties:changed",
height: 1000

Attribute	Format	Description
`height`	Integer	The height of the dashboard iframe in pixels

Build on Examples and Tutorials

Python SDK Examples

Source code examples and projects that use SDKs to communicate with the Looker API.

Language Specific Content

Data from a Look to a Block

The Get Look Data Block contains an API call for retrieving the results of a Look.

2. Retrieving data from the iframe

Retrieving data from the iframe

Accessing events in JavaScript

Event type summary table

Event type reference

dashboard:loaded

dashboard:run:start

dashboard:run:complete

dashboard:download

dashboard:save:complete

dashboard:delete:complete

dashboard:tile:start

dashboard:tile:complete

dashboard:tile:download

dashboard:tile:explore

dashboard:tile:view

dashboard:filters:changed

look:ready

look:run:start

look:run:complete

look:save:complete

look:delete:complete

drillmenu:click

drillmodal:download

drillmodal:explore

explore:ready

explore:run:start

explore:run:complete

explore:state:changed

page:changed

page:properties:changed

Build on Examples and Tutorials

Python SDK Examples

Language Specific Content

Data from a Look to a Block

API

Embedding

Actions

Extensions

Components

Marketplace

Community

`dashboard:loaded`

`dashboard:run:start`

`dashboard:run:complete`

`dashboard:download`

`dashboard:save:complete`

`dashboard:delete:complete`

`dashboard:tile:start`

`dashboard:tile:complete`

`dashboard:tile:download`

`dashboard:tile:explore`

`dashboard:tile:view`

`dashboard:filters:changed`

`look:ready`

`look:run:start`

`look:run:complete`

`look:save:complete`

`look:delete:complete`

`drillmenu:click`

`drillmodal:download`

`drillmodal:explore`

`explore:ready`

`explore:run:start`

`explore:run:complete`

`explore:state:changed`

`page:changed`

`page:properties:changed`