Get all dashboards

Returns a list of dashboards owned by or shared with the user. The list may be filtered to include only favorite or owned dashboards. This operation can be accessed anonymously. **[Permissions](#permissions) required:** None.

Script jira Verified

by hugo697 ยท 11/2/2023

The script

Submitted by hugo697 Typescript (fetch-only)
Verified 396 days ago
1
type Jira = {
2
  username: string;
3
  password: string;
4
  domain: string;
5
};
6
/**
7
 * Get all dashboards
8
 * Returns a list of dashboards owned by or shared with the user. The list may be filtered to include only favorite or owned dashboards.
9

10
This operation can be accessed anonymously.
11

12
**[Permissions](#permissions) required:** None.
13
 */
14
export async function main(
15
  auth: Jira,
16
  filter: "my" | "favourite" | undefined,
17
  startAt: string | undefined,
18
  maxResults: string | undefined
19
) {
20
  const url = new URL(
21
    `https://${auth.domain}.atlassian.net/rest/api/2/dashboard`
22
  );
23
  for (const [k, v] of [
24
    ["filter", filter],
25
    ["startAt", startAt],
26
    ["maxResults", maxResults],
27
  ]) {
28
    if (v !== undefined && v !== "") {
29
      url.searchParams.append(k, v);
30
    }
31
  }
32
  const response = await fetch(url, {
33
    method: "GET",
34
    headers: {
35
      Authorization: "Basic " + btoa(`${auth.username}:${auth.password}`),
36
    },
37
    body: undefined,
38
  });
39
  if (!response.ok) {
40
    const text = await response.text();
41
    throw new Error(`${response.status} ${text}`);
42
  }
43
  return await response.json();
44
}
45