Reference

The reference is organized into four sections, listed in the sidebar.

REST API

HTTP endpoints for retrieving dashboards, downloading datasource data, and creating embed tokens. Includes authentication requirements, request schemas, and responses.

JavaScript API

Methods and types for loading and controlling a dashboard in your page: component state, filters, events, rendering status, and image export.

Iframe protocol

Messages for reading and updating an iframe dashboard through postMessage, including commands, replies, events, and payload validation. Replies and events are addressed to the origin of your first command; see Host origin.

Shared values

State formats, validation schemas, and errors used by both JavaScript and iframe embeds. These describe component values, accepted inputs, write permissions, and rejected updates.

For setup instructions and examples, start with Choose an embed.