Dashboards

Get gadgets

Returns a list of dashboard gadgets on a dashboard.

This operation returns:

  • Gadgets from a list of IDs, when id is set.
  • Gadgets with a module key, when moduleKey is set.
  • Gadgets from a list of URIs, when uri is set.
  • All gadgets, when no other parameters are set.

This operation can be accessed anonymously.

Permissions required: None.

get/rest/api/3/dashboard/{dashboardId}/gadget

Request

  • Base URL
    https://your-domain.atlassian.net
  • URL
    https://your-domain.atlassian.net/rest/api/3/dashboard/{dashboardId}/gadget
  • 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

dashboardIdinteger required

The ID of the dashboard.

Query parameters

moduleKeystring[]

The list of gadgets module keys. To include multiple module keys, separate module keys with ampersand: moduleKey=key:one&moduleKey=key:two.

uristring[]

The list of gadgets URIs. To include multiple URIs, separate URIs with ampersand: uri=/rest/example/uri/1&uri=/rest/example/uri/2.

gadgetIdinteger[]

The list of gadgets IDs. To include multiple IDs, separate IDs with ampersand: gadgetId=10000&gadgetId=10001.

Response

Returned if the request is successful.

Changes

No recorded changes to this operation across all 36 revisions of this API.