Get dashboard

GET

/rest/api/3/dashboard/{id}

Dashboards

Returns a dashboard.

This operation can be accessed anonymously.

Permissions required: None.

However, to get a dashboard, the dashboard must be shared with the user or the user must own it. Note, users with the Administer Jira global permission are considered owners of the System dashboard. The System dashboard is considered to be shared with all other users.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'http://jira.local:8080/jira/rest//rest/api/3/dashboard/'

Response Example

200 - Success

{
  "id": "10000",
  "isFavourite": false,
  "name": "System Dashboard",
  "popularity": 1,
  "self": "https://your-domain.atlassian.net/rest/api/3/dashboard/10000",
  "sharePermissions": [
    {
      "type": "global"
    }
  ],
  "view": "https://your-domain.atlassian.net/secure/Dashboard.jspa?selectPageId=10000"
}

Request

Path Params

string

required

The ID of the dashboard.

Responses

🟢200Returned if the request is successful.

application/json

Body

Details of a dashboard.

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.

group

object

optional

The group that the filter is shared with. For a request, specify the groupId or name property for the group. As a group's name can change, use of groupId is recommended.

integer <int64>

read-onlyoptional

The unique identifier of the share permission.

project

object

optional

The project that the filter is shared with. This is similar to the project object returned by Get project but it contains a subset of the properties, which are: self, id, key, assigneeType, name, roles, avatarUrls, projectType, simplified.
For a request, specify the id for the project.

role

object

optional

The project role that the filter is shared with.
For a request, specify the id for the role. You must also specify the project object and id for the project that the role is in.

type

enum<string>

required

The type of share permission:

user Shared with a user.

group Shared with a group. If set in a request, then specify sharePermission.group as well.

project Shared with a project. If set in a request, then specify sharePermission.project as well.

projectRole Share with a project role in a project. This value is not returned in responses. It is used in requests, where it needs to be specify with projectId and projectRoleId.

global Shared globally. If set in a request, no other sharePermission properties need to be specified.

loggedin Shared with all logged-in users. Note: This value is set in a request by specifying authenticated as the type.

project-unknown Shared with a project that the user does not have access to. Cannot be set in a request.

Allowed values:

usergroupprojectprojectRolegloballoggedinauthenticatedproject-unknown

user

object

optional

The user account ID that the filter is shared with. For a request, specify the accountId property for the user.

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.

accountId

string

optional

The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5.

<= 128 characters

active

boolean

optional

Whether the user is active.

avatarUrls

object

optional

The avatars of the user.

displayName

string

optional

The display name of the user. Depending on the user’s privacy setting, this may return an alternative value.

key

string

optional

This property is deprecated in favor of accountId because of privacy changes. See the migration guide for details.
The key of the user.

name

string

optional

This property is deprecated in favor of accountId because of privacy changes. See the migration guide for details.
The username of the user.

self

string <uri>

optional

The URL of the user.

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.

group

object

optional

The group that the filter is shared with. For a request, specify the groupId or name property for the group. As a group's name can change, use of groupId is recommended.

integer <int64>

read-onlyoptional

The unique identifier of the share permission.

project

object

optional

role

object

optional

The project role that the filter is shared with.
For a request, specify the id for the role. You must also specify the project object and id for the project that the role is in.

type

enum<string>

required

The type of share permission:

user Shared with a user.

group Shared with a group. If set in a request, then specify sharePermission.group as well.

project Shared with a project. If set in a request, then specify sharePermission.project as well.

projectRole Share with a project role in a project. This value is not returned in responses. It is used in requests, where it needs to be specify with projectId and projectRoleId.

global Shared globally. If set in a request, no other sharePermission properties need to be specified.

loggedin Shared with all logged-in users. Note: This value is set in a request by specifying authenticated as the type.

project-unknown Shared with a project that the user does not have access to. Cannot be set in a request.

Allowed values:

usergroupprojectprojectRolegloballoggedinauthenticatedproject-unknown

user

object

optional

The user account ID that the filter is shared with. For a request, specify the accountId property for the user.

systemDashboard

boolean

read-onlyoptional

Whether the current dashboard is system dashboard.

view

string

read-onlyoptional

The URL of the dashboard.

🟠400400 response

🟠401Returned if the authentication credentials are incorrect or missing.

🟠404Returned if the dashboard is not found or the dashboard is not owned by or shared with the user.

Modified at 2023-07-13 03:27:27

Delete dashboard item property

Update dashboard