Skip to main content
List your company’s reporting dashboards, with an optional name filter and pagination. Each row summarizes one dashboard: its name, description, and when it was last updated. Dashboards live under the reports section; a dashboard groups visualizations of existing reports — call get_dashboard for a dashboard’s tiles, their layout, and the reports they render. You only see the dashboards you have access to — every one of the company’s at full dashboard access, otherwise only those shared with you (by role or individually); the rest are omitted.

Parameters

Body

Filter matched against the dashboard name (case- and accent-insensitive substring) or, when it is a valid ObjectId, against the dashboard id.
string
Id of the sandbox to read instead of the live environment — the id list_sandboxes returns. Omit it to read the live environment, the company’s real compensation data, which is the right choice unless the question is explicitly about a sandbox. Only a sandbox id is accepted here — never a sandbox name, and never the live environment’s own id.
integer
Page size, between 1 and 250. Defaults to 50.
integer
Row offset into the result set — the number of rows to skip before this page. Any offset >= 0 is accepted; it does not have to be a multiple of limit, so you can start from an arbitrary row. Pass the next_offset returned by the previous call to walk the pages, or None for the first page.

Response

Body

object[]
integer