API for Dashboards and Notebooks

Latest Dynatrace

The Dynatrace platform provides a collection of platform services, each with a specific area of responsibility. You need one of these services, the document service, to manage Dynatrace documents such as dashboards and notebooks via API.

Access document data

The Dashboard Dashboards and Notebooks Notebooks apps use the document service API to persist data as documents.

Documents are content-agnostic, but both notebook and dashboard documents have common metadata: a unique identifier, a name, and a description.

To distinguish notebook and dashboard documents, and to make them visible to the respective apps, they need the correct type document attribute: dashboard or notebook. This attribute can also be used to query the API as shown in the following examples.

List all accessible dashboards

https://environment/platform/document/v1/documents?filter=type='dashboard'

List all accessible notebooks

https://environment/platform/document/v1/documents?filter=type='notebook'

Access full document service documentation

To see the full API documentation for the documents service

  1. Go to the Document service page of the Dynatrace Developer site.

  2. In the Related links section, select the Swagger API link.

    You may need to sign in to your Dynatrace environment.