Search for dashboards

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.

{ "self": "https://your-domain.atlassian.net/rest/api/3/dashboard/search?expand=owner&maxResults=50&startAt=0", "maxResults": 100, "startAt": 0, "total": 2, "isLast": true, "values": [ { "description": "Testing program", "id": "1", "isFavourite": true, "name": "Testing", "owner": { "self": "https://your-domain.atlassian.net/user?accountId=5b10a2844c20165700ede21g", "displayName": "Mia", "active": true, "accountId": "5b10a2844c20165700ede21g", "avatarUrls": { "16x16": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16", "24x24": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24", "32x32": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32", "48x48": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48" } }, "popularity": 1, "self": "https://your-domain.atlassian.net/rest/api/3/dashboard/1", "sharePermissions": [ { "type": "global" } ], "view": "https://your-domain.atlassian.net/Dashboard.jspa?selectPageId=1" }, { "description": "Quantum initiative", "id": "2", "isFavourite": false, "name": "Quantum ", "owner": { "self": "https://your-domain.atlassian.net/user?accountId=5b10a2844c20165700ede21g", "displayName": "Mia", "active": true, "accountId": "5b10a2844c20165700ede21g", "avatarUrls": { "16x16": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16", "24x24": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24", "32x32": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32", "48x48": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48" } }, "popularity": 0, "self": "https://your-domain.atlassian.net/rest/api/3/dashboard/2", "sharePermissions": [ { "type": "loggedin" } ], "view": "https://your-domain.atlassian.net/Dashboard.jspa?selectPageId=2" } ] }

Request

Query Params

dashboardName

string

optional

String used to perform a case-insensitive partial match with name.

accountId

string

optional

User account ID used to return dashboards with the matching owner.accountId. This parameter cannot be used with the owner parameter.

owner

string

optional

This parameter is deprecated because of privacy changes. Use accountId instead. See the migration guide for details. User name used to return dashboards with the matching owner.name. This parameter cannot be used with the accountId parameter.

groupname

string

optional

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.

groupId

string

optional

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.

projectId

integer

optional

Project ID used to returns dashboards that are shared with a project that matches sharePermissions.project.id.

orderBy

string

optional

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.

startAt

integer

optional

The index of the first item to return in a page of results (page offset).

maxResults

integer

optional

The maximum number of items to return per page.

status

string

optional

The status to filter by. It may be active, archived or deleted.

expand

string

optional

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.

Responses

🟢200Returned if the request is successful.

application/json

Body

A page of items.

isLast

boolean

read-onlyoptional

Whether this is the last page.

maxResults

integer <int32>

read-onlyoptional

The maximum number of items that could be returned.

string <uri>

read-onlyoptional

If there is another page of results, the URL of the next page.

self

string <uri>

read-onlyoptional

The URL of the page.

startAt

integer <int64>

read-onlyoptional

The index of the first item returned.

total

integer <int64>

read-onlyoptional

The number of items returned.

values

array[object (Dashboard) {14}]

read-onlyoptional

The list of items.

automaticRefreshMs

integer <int32>

read-onlyoptional

The automatic refresh interval for the dashboard in milliseconds.

description

string

optional

editPermissions

array[object (SharePermission) {6}]

read-onlyoptional

The details of any edit share permissions for the dashboard.

string

read-onlyoptional

The ID of the dashboard.

isFavourite

boolean

read-onlyoptional

Whether the dashboard is selected as a favorite by the user.

isWritable

boolean

read-onlyoptional

Whether the current user has permission to edit the dashboard.

name

string

read-onlyoptional

The name of the dashboard.

owner

object

read-onlyoptional

The owner of the dashboard.

popularity

integer <int64>

read-onlyoptional

The number of users who have this dashboard as a favorite.

rank

integer <int32>

read-onlyoptional

The rank of this dashboard.

self

string <uri>

read-onlyoptional

The URL of these dashboard details.

sharePermissions

array[object (SharePermission) {6}]

read-onlyoptional

The details of any view share permissions for the dashboard.

systemDashboard

boolean

read-onlyoptional

Whether the current dashboard is system dashboard.

view

string

read-onlyoptional

The URL of the dashboard.

🟠400Returned if: * `orderBy` is invalid. * `expand` includes an invalid value. * `accountId` and `owner` are provided. * `groupname` and `groupId` are provided.

🟠401401 response