Searches dashboards with column filters and free-text terms, sorts the results by id, name, status, updated_at, or created_at in ascending or descending order, and returns a paged list. Set only_archived to true to search archived dashboards only.

When to use it

Use it to combine several search terms, filter on specific columns, or control the sort order of the results.

Required parameters

This call takes no required parameters.

Optional body fields: filters, search, sort_by, sort_direction, only_archived. Use page and size to page through the results.

Response

A successful call returns 200 OK with a page of Dashboard objects in items, plus the paging fields total, page, size, and pages.

Related: List dashboards, Get a dashboard, List dashboards with a tag