Dashboards API - GET a dashboard

Gets parameters of the specified dashboard.

The request produces an application/json payload.

This request is an early adopter release and may be changed in non compatible way.

GET
  • Managed https://{your-domain}/e/{your-environment-id}/api/config/v1/dashboards/{id}
  • SaaS https://{your-environment-id}.live.dynatrace.com/api/config/v1/dashboards/{id}

Parameters

Parameter Type Description In Required
id string

The ID of the required dashboard.

path required

Response format

Refer to Tile JSON models to find JSON models for each tile type.

The Dashboard object

Configuration of a dashboard.

Element Type Description
metadata ConfigurationMetadata

Metadata useful for debugging.

id string

The ID of the dashboard.

dashboardMetadata DashboardMetadata

Parameters of the dashboard.

tiles Tile[]

The list of tiles on the dashboard.

The Tile object

Configuration of a tile.

The actual set of fields depends on the type of the tile.

Element Type Description
name string

The name of the tile.

tileType string

Defines the actual set of fields depending on the value:

CUSTOM_CHARTING -> CustomChartingTile DTAQL -> UserSessionQueryTile MARKDOWN -> MarkdownTile HOSTS -> FilterableEntityTile APPLICATIONS -> FilterableEntityTile SERVICES -> FilterableEntityTile DATABASES_OVERVIEW -> FilterableEntityTile SYNTHETIC_TESTS -> FilterableEntityTile APPLICATION_WORLDMAP -> AssignedEntitiesWithMetricTile RESOURCES -> AssignedEntitiesWithMetricTile THIRD_PARTY_MOST_ACTIVE -> AssignedEntitiesWithMetricTile SYNTHETIC_SINGLE_WEBCHECK -> AssignedEntitiesWithMetricTile UEM_CONVERSIONS_PER_GOAL -> AssignedEntitiesWithMetricTile HOST -> AssignedEntitiesWithMetricTile PROCESS_GROUPS_ONE -> AssignedEntitiesWithMetricTile SYNTHETIC_SINGLE_WEBCHECK -> SyntheticSingleWebcheckTile APPLICATION -> AssignedEntitiesTile VIRTUALIZATION -> AssignedEntitiesTile AWS -> AssignedEntitiesTile SERVICE_VERSATILE -> AssignedEntitiesTile SESSION_METRICS -> AssignedEntitiesTile USERS -> AssignedEntitiesTile UEM_KEY_USER_ACTIONS -> AssignedEntitiesTile BOUNCE_RATE -> AssignedEntitiesTile UEM_CONVERSIONS_OVERALL -> AssignedEntitiesTile UEM_JSERRORS_OVERALL -> AssignedEntitiesTile MOBILE_APPLICATION -> AssignedEntitiesTile SYNTHETIC_SINGLE_EXT_TEST -> AssignedEntitiesTile SYNTHETIC_HTTP_MONITOR -> AssignedEntitiesTile DATABASE -> AssignedEntitiesTile CUSTOM_APPLICATION -> AssignedEntitiesTile APPLICATION_METHOD -> AssignedEntitiesTile LOG_ANALYTICS -> AssignedEntitiesTile OPENSTACK -> AssignedEntitiesTile OPENSTACK_PROJECT -> AssignedEntitiesTile OPENSTACK_AV_ZONE -> AssignedEntitiesTile

configured boolean

The tile is configured and ready to use (true) or just placed on the dashboard (false).

bounds TileBounds

The position and size of the tile.

tileFilter TileFilter

A filter, applied to the tile.

The TileFilter object

A filter applied to a tile.

It overrides dashboard's filter.

Element Type Description
timeframe string

The default timeframe of the tile.

managementZone EntityShortRepresentation

The management zone to which the tile belongs.

The TileBounds object

The position and size of a tile.

Element Type Description
top integer

The vertical distance from the top left corner of the dashboard to the top left corner of the tile, in pixels.

left integer

The horizontal distance from the top left corner of the dashboard to the top left corner of the tile, in pixels.

width integer

The width of the tile, in pixels.

height integer

The height of the tile, in pixels.

The DashboardMetadata object

Parameters of a dashboard.

Element Type Description
name string

The name of the dashboard.

shared boolean

The dashboard is shared (true) or private (false).

owner string

The owner of the dashboard.

sharingDetails SharingInfo

How the dashboard is shared.

If shared is set to false these settings are saved but not used.

dashboardFilter DashboardFilter

Filters, applied to the dashboard.

The DashboardFilter object

Filters, applied to a dashboard.

Element Type Description
timeframe string

The default timeframe of the dashboard.

managementZone EntityShortRepresentation

The management zone to which the dashboard belongs.

The EntityShortRepresentation object

The short representation of a Dynatrace entity.

Element Type Description
id string

The ID of the Dynatrace entity.

name string

The name of the Dynatrace entity.

description string

A short description of the Dynatrace entity.

The SharingInfo object

Sharing configuration of a dashboard.

Element Type Description
linkShared boolean

If true, the dashboard is shared via link and authenticated users with the link can view.

published boolean

If true, the dashboard is published to anyone on this environment.

The ConfigurationMetadata object

Metadata useful for debugging

Element Type Description
configurationVersions integer[]

A Sorted list of the version numbers of the configuration.

clusterVersion string

Dynatrace server version.

Example

In this example, the request lists the parameters of the Sample dashboard, which has the ID of 2768e6ca-e199-4433-9e0d-2922aec2099b.

The API token is passed in the Authorization header.

The dashboard looks like this in the UI:

Sample dashboard

Curl

curl -X GET \
  https://mySampleEnv.live.dynatrace.com/api/config/v1/dashboards/2768e6ca-e199-4433-9e0d-2922aec2099b \
  -H 'Authorization: Api-token abcdefjhij1234567890'

Request URL

https://mySampleEnv.live.dynatrace.com/api/config/v1/dashboards/2768e6ca-e199-4433-9e0d-2922aec2099b

Response body

{
  "metadata": {
    "clusterVersion": "1.166.0.20190311-110828",
    "configurationVersions": [
      2
    ]
  },
  "id": "2768e6ca-e199-4433-9e0d-2922aec2099b",
  "dashboardMetadata": {
    "name": "Sample dashboard",
    "shared": true,
    "owner": "john.smith",
    "sharingDetails": {
      "linkShared": true,
      "published": true
    },
    "dashboardFilter": {
      "timeframe": "l_2_HOURS",
      "managementZone": null
    }
  },
  "tiles": [
    {
      "name": "Host health",
      "tileType": "HOSTS",
      "configured": true,
      "bounds": {
        "top": 0,
        "left": 304,
        "width": 304,
        "height": 304
      },
      "tileFilter": {
        "managementZone": {
          "id": "9130632296508575249",
          "name": "Easytravel"
        }
      },
      "filterConfig": null,
      "chartVisible": true
    },
    {
      "name": "User behavior",
      "tileType": "SESSION_METRICS",
      "configured": true,
      "bounds": {
        "top": 0,
        "left": 0,
        "width": 304,
        "height": 304
      },
      "tileFilter": {
        "managementZone": null
      },
      "assignedEntities": [
        "APPLICATION-8E41C8C247910758"
      ]
    }
  ]
}

Response code

200