Function: list()

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

Defined in: src/server/api/dashboards.ts:14

Returns a list of all dashboards, optionally filtering them.

Parameters

Parameter	Type	Description
client	Client	-
parameters?	{ filter?: string; maxResults?: string; startAt?: string; }	-
parameters.filter?	string	An optional filter that is applied to the list of dashboards.
parameters.maxResults?	string	A hint as to the maximum number of dashboards to return in each call.
parameters.startAt?	string	The index of the first dashboard to return (0-based).
options?	RequestOptions	-

Returns

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