Sign in

v1

latestOpenAPI 3.0.32026-08-061874701.5 MB
dashboards

List dashboards

Gets a list of all dashboards that the user has access to.

Note: For pagination guidance, refer to Token-based pagination.

get/sights

Query parameters

numericDatesboolean

You can optionally choose to receive and send dates/times in numeric format, as milliseconds since the UNIX epoch (midnight on January 1, 1970 in UTC time), using the query string parameter numericDates with a value of true. This query parameter works for any API request.

lastKeystring
Example:abcDefGhIjKlMnOpQrStUvWxYz

The lastKey token returned from the previous page of results. If not specified, the first page of results is returned.

maxItemsinteger

The maximum number of items to return in the response. The actual number of items returned may be less than maxItems.

If the total number of dashboards the user has access to exceeds maxItems, the response will include a lastKey field. This key can be used as a parameter in subsequent requests to retrieve additional items beyond those already returned.

Response

IndexResult object containing an array of Dashboard objects with a subset of attributes.

Note: For pagination guidance, refer to Pagination.

lastKeystring

A token that is used to retrieve the next page of results when passed as the lastKey query parameter. This value will be absent when there are no further pages.

Example response

{
  "lastKey": "abcDefGhIjKlMnOpQrStUvWxYz"
}