Function: getAllDashboards()

function getAllDashboards(
   client, 
   parameters?, 
   options?
): Promise<{
[key: string]: unknown;
  dashboards?: object[];
  maxResults?: number;
  next?: string;
  prev?: string;
  startAt?: number;
  total?: number;
}>;

Defined in: src/cloud/api/dashboards.ts:24

Returns a list of dashboards owned by or shared with the user. The list may be filtered to include only favorite or owned dashboards.

This operation can be accessed anonymously.

Permissions required: None.

Parameters

Parameter	Type	Description
client	Client	-
parameters?	{ filter?: string & object | "favourite" | "my"; maxResults?: number; startAt?: number; }	-
parameters.filter?	string & object | "favourite" | "my"	The filter applied to the list of dashboards. Valid values are: - favourite Returns dashboards the user has marked as favorite. - my Returns dashboards owned by the user.
parameters.maxResults?	number	The maximum number of items to return per page.
parameters.startAt?	number	The index of the first item to return in a page of results (page offset).
options?	RequestOptions	-

Returns

Promise<{ [key: string]: unknown; dashboards?: object[]; maxResults?: number; next?: string; prev?: string; startAt?: number; total?: number; }>