SOsolarwinds
dashboards

Get a dashboard by ID

Changed on
get/v1/dashboards/{dashboardId}

Request

Path parameters

dashboardIdstring required

Dashboard identifier.

Response

The requested dashboard.

idstring required

Dashboard identifier.

versioninteger nullable required

Schema version of the dashboard definition. Null implies version 1.

namestring required

Dashboard display name.

descriptionstring nullable required

Dashboard description.

systemReferencestring nullable required

Stable reference key for system dashboards; null for user-created dashboards.

isPrivateboolean required

Whether the dashboard is private to the owning user.

ownerIdstring nullable required

Identifier of the user who owns this dashboard.

createdAtstring date-time required

Timestamp when the dashboard was created.

updatedAtstring date-time required

Timestamp when the dashboard was last updated.

isFavoriteboolean required

Whether the current user has marked this dashboard as a favorite.

Example response

{
  "id": "68564",
  "name": "APM Usage",
  "description": "Displays metric widgets of APM data usage.",
  "category": {
    "id": "4",
    "name": "APM",
    "createdAt": "2022-12-22T11:21:50.000Z",
    "updatedAt": "2022-12-22T11:21:50.000Z"
  },
  "systemReference": "apm-usage",
  "createdAt": "2022-12-22T11:21:50.000Z",
  "updatedAt": "2022-12-22T11:21:50.000Z",
  "report": {
    "id": "105",
    "title": "test"
  }
}

Changes