Qodex.ai

Search For Dashboards

GET {{baseUrl}}/rest/api/3/dashboard/search?dashboardName=<string>&accountId=<string>&owner=<string>&groupname=<string>&projectId=<long>&orderBy=name&startAt=0&maxResults=50&expand=<string>

Returns a paginated list of dashboards. This operation is similar to Get dashboards except that the results can be refined to include dashboards that have specific attributes. For example, dashboards with a particular name. When multiple attributes are specified only filters matching all attributes are returned.

This operation can be accessed anonymously.

Permissions required: The following dashboards that match the query parameters are returned:

  • Dashboards owned by the user. Not returned for anonymous users.
  • Dashboards shared with a group that the user is a member of. Not returned for anonymous users.
  • Dashboards shared with a private project that the user can browse. Not returned for anonymous users.
  • Dashboards shared with a public project.
  • Dashboards shared with the public.

Request Params

KeyDatatypeRequiredDescription
dashboardNamestringString used to perform a case-insensitive partial match with name.
accountIdstringUser account ID used to return dashboards with the matching owner.accountId. This parameter cannot be used with the owner parameter.
ownerstringThis parameter is deprecated because of privacy changes. Use accountId instead. See the migration guide for details. User name used to return dashboards with the matching owner.name. This parameter cannot be used with the accountId parameter.
groupnamestringGroup name used to returns dashboards that are shared with a group that matches sharePermissions.group.name.
projectIdstringProject ID used to returns dashboards that are shared with a project that matches sharePermissions.project.id.
orderBystringOrder the results by a field:

  • description Sorts by dashboard description. Note that this sort works independently of whether the expand to display the description field is in use.

  • favourite_count Sorts by dashboard popularity.

  • id Sorts by dashboard ID.

  • is_favourite Sorts by whether the dashboard is marked as a favorite.

  • name Sorts by dashboard name.

  • owner Sorts by dashboard owner name. | | startAt | number | | The index of the first item to return in a page of results (page offset). | | maxResults | number | | The maximum number of items to return per page. | | expand | string | | Use expand to include additional information about dashboard in the response. This parameter accepts a comma-separated list. Expand options include:

  • description Returns the description of the dashboard.

  • owner Returns the owner of the dashboard.

  • viewUrl Returns the URL that is used to view the dashboard.

  • favourite Returns isFavourite, an indicator of whether the user has set the dashboard as a favorite.

  • favouritedCount Returns popularity, a count of how many users have set this dashboard as a favorite.

  • sharePermissions Returns details of the share permissions defined for the dashboard. |

RESPONSES

status: OK

{&quot;self&quot;:&quot;https://your-domain.atlassian.net/rest/api/3/dashboard/search?expand=owner\u0026maxResults=50\u0026startAt=0&quot;,&quot;maxResults&quot;:100,&quot;startAt&quot;:0,&quot;total&quot;:2,&quot;isLast&quot;:true,&quot;values&quot;:[{&quot;description&quot;:&quot;Testing program&quot;,&quot;id&quot;:&quot;1&quot;,&quot;isFavourite&quot;:true,&quot;name&quot;:&quot;Testing&quot;,&quot;owner&quot;:{&quot;self&quot;:&quot;https://your-domain.atlassian.net/user?accountId=5b10a2844c20165700ede21g&quot;,&quot;displayName&quot;:&quot;Mia&quot;,&quot;active&quot;:true,&quot;accountId&quot;:&quot;5b10a2844c20165700ede21g&quot;,&quot;avatarUrls&quot;:{&quot;32x32&quot;:&quot;https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32\u0026s=32&quot;,&quot;16x16&quot;:&quot;https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16\u0026s=16&quot;,&quot;48x48&quot;:&quot;https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48\u0026s=48&quot;,&quot;24x24&quot;:&quot;https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24\u0026s=24&quot;}},&quot;popularity&quot;:1,&quot;self&quot;:&quot;https://your-domain.atlassian.net/rest/api/3/dashboard/1&quot;,&quot;sharePermissions&quot;:[{&quot;type&quot;:&quot;global&quot;}],&quot;view&quot;:&quot;https://your-domain.atlassian.net/Dashboard.jspa?selectPageId=1&quot;},{&quot;description&quot;:&quot;Quantum initiative&quot;,&quot;id&quot;:&quot;2&quot;,&quot;isFavourite&quot;:false,&quot;name&quot;:&quot;Quantum &quot;,&quot;owner&quot;:{&quot;self&quot;:&quot;https://your-domain.atlassian.net/user?accountId=5b10a2844c20165700ede21g&quot;,&quot;displayName&quot;:&quot;Mia&quot;,&quot;active&quot;:true,&quot;accountId&quot;:&quot;5b10a2844c20165700ede21g&quot;,&quot;avatarUrls&quot;:{&quot;32x32&quot;:&quot;https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32\u0026s=32&quot;,&quot;16x16&quot;:&quot;https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16\u0026s=16&quot;,&quot;48x48&quot;:&quot;https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48\u0026s=48&quot;,&quot;24x24&quot;:&quot;https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24\u0026s=24&quot;}},&quot;popularity&quot;:0,&quot;self&quot;:&quot;https://your-domain.atlassian.net/rest/api/3/dashboard/2&quot;,&quot;sharePermissions&quot;:[{&quot;type&quot;:&quot;loggedin&quot;}],&quot;view&quot;:&quot;https://your-domain.atlassian.net/Dashboard.jspa?selectPageId=2&quot;}]}