Atlassian: Get dashboard
Atlassian dashboards.getDashboard: arguments, response, policy and SDK examples.
← Dashboards operations · Get started
Operation atlassian.getdashboard
Provider route: GET /{cloudId}/rest/api/3/dashboard/{id}. Alter supplies the connection’s credentials and routing.
Call through Alter
Section titled “Call through Alter”Install @alter-ai/sdk @alter-ai/atlassian with npm, or alter-sdk-atlassian with pip. Supply your connected customer’s grant ID and the arguments described below.
import { App } from "@alter-ai/sdk";import { AtlassianIntegration } from "@alter-ai/atlassian";
async function execute(input: Parameters<AtlassianIntegration["dashboards"]["getDashboard"]>[0]) { const app = new App({ apiKey: process.env.ALTER_API_KEY! }); try { const provider = new AtlassianIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! }); const call = await provider.dashboards.getDashboard(input); const result = await call.wait(); return result.bodyJson(); } finally { await app.close(); }}import osfrom alter_sdk import Appfrom alter_sdk_atlassian import AtlassianIntegration
async def execute(arguments): async with App(api_key=os.environ["ALTER_API_KEY"]) as app: provider = AtlassianIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]}) call = await provider.dashboards.get_dashboard(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
path | object | Required within parent | Additional keys: not allowed |
path.cloudId | string | Required within parent | Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ |
path.id | string | Required within parent |
Response
Section titled “Response”Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | Model | Root | Expand Get dashboard — response body |
Referenced models: Get dashboard — response body
Schemas
Section titled “Schemas”26 more schemas are linked from the tables above, on the schema pages.
Get dashboard — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Details of a dashboard. |
automaticRefreshMs | JSON | Optional | |
automaticRefreshMs (anyOf 1) | JSON | Alternative | |
automaticRefreshMs (anyOf 1) (anyOf 1) | integer | Alternative | The automatic refresh interval for the dashboard in milliseconds. Format: int32 Read only: true |
automaticRefreshMs (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
automaticRefreshMs (anyOf 2) | null | Alternative | |
description | JSON | Optional | |
description (anyOf 1) | string | Alternative | |
description (anyOf 2) | null | Alternative | |
editPermissions | JSON | Optional | |
editPermissions (anyOf 1) | array | Alternative | The details of any edit share permissions for the dashboard. Read only: true |
editPermissions (anyOf 1)[] | Model | Each item | Expand Get share permission — response body |
editPermissions (anyOf 2) | null | Alternative | |
id | JSON | Optional | |
id (anyOf 1) | string | Alternative | The ID of the dashboard. Read only: true |
id (anyOf 2) | null | Alternative | |
isFavourite | JSON | Optional | |
isFavourite (anyOf 1) | boolean | Alternative | Whether the dashboard is selected as a favorite by the user. Read only: true |
isFavourite (anyOf 2) | null | Alternative | |
isWritable | JSON | Optional | |
isWritable (anyOf 1) | boolean | Alternative | Whether the current user has permission to edit the dashboard. Read only: true |
isWritable (anyOf 2) | null | Alternative | |
name | JSON | Optional | |
name (anyOf 1) | string | Alternative | The name of the dashboard. Read only: true |
name (anyOf 2) | null | Alternative | |
owner | JSON | Optional | |
owner (anyOf 1) | Model | Alternative | Expand Get share permission — response body — user account Id, active, avatar Urls, display Name, key, name, self The owner of the dashboard. Read only: true |
owner (anyOf 2) | null | Alternative | |
popularity | JSON | Optional | |
popularity (anyOf 1) | JSON | Alternative | |
popularity (anyOf 1) (anyOf 1) | integer | Alternative | The number of users who have this dashboard as a favorite. Format: int64 Read only: true |
popularity (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
popularity (anyOf 2) | null | Alternative | |
rank | JSON | Optional | |
rank (anyOf 1) | JSON | Alternative | |
rank (anyOf 1) (anyOf 1) | integer | Alternative | The rank of this dashboard. Format: int32 Read only: true |
rank (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
rank (anyOf 2) | null | Alternative | |
self | JSON | Optional | |
self (anyOf 1) | string | Alternative | The URL of these dashboard details. Format: uri Read only: true |
self (anyOf 2) | null | Alternative | |
sharePermissions | JSON | Optional | |
sharePermissions (anyOf 1) | array | Alternative | The details of any view share permissions for the dashboard. Read only: true |
sharePermissions (anyOf 1)[] | Model | Each item | Expand Get share permission — response body |
sharePermissions (anyOf 2) | null | Alternative | |
systemDashboard | JSON | Optional | |
systemDashboard (anyOf 1) | boolean | Alternative | Whether the current dashboard is system dashboard. Read only: true |
systemDashboard (anyOf 2) | null | Alternative | |
view | JSON | Optional | |
view (anyOf 1) | string | Alternative | The URL of the dashboard. Read only: true |
view (anyOf 2) | null | Alternative |
Referenced models: Get share permission — response body, Get share permission — response body — user account Id, active, avatar Urls, display Name, key, name, self
Get share permission — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Details of a share permission for the filter. |
group | JSON | Optional | |
group (anyOf 1) | Model | Alternative | Expand Get user groups — response body — item 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. |
group (anyOf 2) | null | Alternative | |
id | JSON | Optional | |
id (anyOf 1) | JSON | Alternative | |
id (anyOf 1) (anyOf 1) | integer | Alternative | The unique identifier of the share permission. Format: int64 Read only: true |
id (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
id (anyOf 2) | null | Alternative | |
project | JSON | Optional | |
project (anyOf 1) | Model | Alternative | Expand Get project — response body The project that the filter is shared with. This is similar to the project object returned by [Get project](#api-rest-api-3-project-projectIdOrKey-get) 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. |
project (anyOf 2) | null | Alternative | |
role | JSON | Optional | |
role (anyOf 1) | Model | Alternative | Expand Create project role — response body 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. |
role (anyOf 2) | null | Alternative | |
type | JSON | Optional | |
type (anyOf 1) | string | Alternative | 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. Known values: user, group, project, projectRole, global, loggedin, authenticated, project-unknown |
type (anyOf 2) | null | Alternative | |
user | JSON | Optional | |
user (anyOf 1) | Model | Alternative | Expand Get share permission — response body — user account Id, active, avatar Urls, display Name, key, name, self The user account ID that the filter is shared with. For a request, specify the `accountId` property for the user. |
user (anyOf 2) | null | Alternative |
Referenced models: Get user groups — response body — item, Get project — response body, Create project role — response body, Get share permission — response body — user account Id, active, avatar Urls, display Name, key, name, self
Get user groups — response body — item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Details about a group. |
groupId | JSON | Optional | |
groupId (anyOf 1) | JSON | Alternative | |
groupId (anyOf 1) (anyOf 1) | string | Alternative | The ID of the group, which uniquely identifies the group across all Atlassian products. For example, *952d12c3-5b5b-4d04-bb32-44d383afc4b2*. |
groupId (anyOf 1) (anyOf 2) | null | Alternative | |
groupId (anyOf 2) | null | Alternative | |
name | JSON | Optional | |
name (anyOf 1) | string | Alternative | The name of group. |
name (anyOf 2) | null | Alternative | |
self | JSON | Optional | |
self (anyOf 1) | string | Alternative | The URL for these group details. Format: uri Read only: true |
self (anyOf 2) | null | Alternative |
Get project — response body — permissions Permissions which a user has on a project
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Permissions which a user has on a project. |
canEdit | JSON | Optional | |
canEdit (anyOf 1) | boolean | Alternative | Whether the logged user can edit the project. Read only: true |
canEdit (anyOf 2) | null | Alternative |
Get user — response body — groups callback, items, max-results, paging Callback, size callback object
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: atlassian.getdashboard. Catalog operation: getdashboard. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.
Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.
Required provider scopes: ["read:jira-work"]