Function: getDashboardsPaginated()

function getDashboardsPaginated(
   client, 
   parameters?, 
   options?
): Promise<{
[key: string]: unknown;
  isLast: boolean;
  maxResults: number;
  nextPage?: string;
  self?: string;
  startAt: number;
  total: number;
  values: object[];
}>;

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

Returns a paginated list of dashboards. This operation is similar to Get dashboards except that the results can be refined to include dashboards that have specific attributes. For example, dashboards with a particular name. When multiple attributes are specified only filters matching all attributes are returned.

This operation can be accessed anonymously.

Permissions required: The following dashboards that match the query parameters are returned:

• Dashboards owned by the user. Not returned for anonymous users.
• Dashboards shared with a group that the user is a member of. Not returned for anonymous users.
• Dashboards shared with a private project that the user can browse. Not returned for anonymous users.
• Dashboards shared with a public project.
• Dashboards shared with the public.

Parameters

Parameter	Type	Description
client	Client	-
parameters?	{ accountId?: string; dashboardName?: string; expand?: | "description" | string & object | "viewUrl" | "owner" | "favourite" | "editPermissions" | "sharePermissions" | "isWritable" | "favouritedCount" | ( | "description" | string & object | "viewUrl" | "owner" | "favourite" | "editPermissions" | "sharePermissions" | "isWritable" | "favouritedCount")[]; groupId?: string; groupname?: string; maxResults?: number; orderBy?: | "name" | "id" | "description" | string & object | "owner" | "-description" | "+description" | "-name" | "+name" | "favorite_count" | "-favorite_count" | "+favorite_count" | "-id" | "+id" | "is_favorite" | "-is_favorite" | "+is_favorite" | "-owner" | "+owner"; projectId?: number; startAt?: number; status?: "deleted" | "active" | string & object | "archived"; }	-
parameters.accountId?	string	User account ID used to return dashboards with the matching owner.accountId. This parameter cannot be used with the owner parameter.
parameters.dashboardName?	string	String used to perform a case-insensitive partial match with name.
parameters.expand?	| "description" | string & object | "viewUrl" | "owner" | "favourite" | "editPermissions" | "sharePermissions" | "isWritable" | "favouritedCount" | ( | "description" | string & object | "viewUrl" | "owner" | "favourite" | "editPermissions" | "sharePermissions" | "isWritable" | "favouritedCount")[]	Use expand to include additional information about dashboard in the response. This parameter accepts a comma-separated list. Expand options include: - description Returns the description of the dashboard. - owner Returns the owner of the dashboard. - viewUrl Returns the URL that is used to view the dashboard. - favourite Returns isFavourite, an indicator of whether the user has set the dashboard as a favorite. - favouritedCount Returns popularity, a count of how many users have set this dashboard as a favorite. - sharePermissions Returns details of the share permissions defined for the dashboard. - editPermissions Returns details of the edit permissions defined for the dashboard. - isWritable Returns whether the current user has permission to edit the dashboard.
parameters.groupId?	string	Group ID used to return dashboards that are shared with a group that matches sharePermissions.group.groupId. This parameter cannot be used with the groupname parameter.
parameters.groupname?	string	As a group's name can change, use of groupId is recommended. Group name used to return dashboards that are shared with a group that matches sharePermissions.group.name. This parameter cannot be used with the groupId parameter.
parameters.maxResults?	number	The maximum number of items to return per page.
parameters.orderBy?	| "name" | "id" | "description" | string & object | "owner" | "-description" | "+description" | "-name" | "+name" | "favorite_count" | "-favorite_count" | "+favorite_count" | "-id" | "+id" | "is_favorite" | "-is_favorite" | "+is_favorite" | "-owner" | "+owner"	Order the results by a field: - description Sorts by dashboard description. Note that this sort works independently of whether the expand to display the description field is in use. - favourite_count Sorts by dashboard popularity. - id Sorts by dashboard ID. - is_favourite Sorts by whether the dashboard is marked as a favorite. - name Sorts by dashboard name. - owner Sorts by dashboard owner name.
parameters.projectId?	number	Project ID used to returns dashboards that are shared with a project that matches sharePermissions.project.id.
parameters.startAt?	number	The index of the first item to return in a page of results (page offset).
parameters.status?	"deleted" | "active" | string & object | "archived"	The status to filter by. It may be active, archived or deleted.
options?	RequestOptions	-

Returns

Promise<{ [key: string]: unknown; isLast: boolean; maxResults: number; nextPage?: string; self?: string; startAt: number; total: number; values: object[]; }>