Dashboards

Get dashboard

Changed on

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.

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

Request

  • Base URL
    https://your-domain.atlassian.net
  • URL
    https://your-domain.atlassian.net/rest/api/3/dashboard/{id}
  • Auth
    • HTTP basic
    • or OAuth 2
      Authorization code: https://auth.atlassian.com/authorize
      Token URL: https://auth.atlassian.com/oauth/token scopes: read:jira-work
    • or none

Path parameters

idstring required

The ID of the dashboard.

Response

Returned if the request is successful.

automaticRefreshMsinteger

The automatic refresh interval for the dashboard in milliseconds.

descriptionstring
idstring

The ID of the dashboard.

isFavouriteboolean

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

isWritableboolean

Whether the current user has permission to edit the dashboard.

namestring

The name of the dashboard.

popularityinteger

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

rankinteger

The rank of this dashboard.

selfstring uri

The URL of these dashboard details.

systemDashboardboolean

Whether the current dashboard is system dashboard.

viewstring

The URL of the dashboard.

Changes

  • 75c9c58763c9Revision changes
    • warning

      added the new product_discovery enum value to the /////////////////// response property for the response status

    • warning

      added the new product_discovery enum value to the /////// response property for the response status

    • warning

      added the new product_discovery enum value to the ///////////////// response property for the response status

    • warning

      added the new product_discovery enum value to the /////////////////// response property for the response status

    • warning

      added the new product_discovery enum value to the /////// response property for the response status

    • warning

      added the new product_discovery enum value to the ///////////////// response property for the response status

  • a4396bcf79c3Revision changes
    • info

      the response optional property ///////// became not read-only for the status

    • info

      the response optional property ///////// became not read-only for the status