Reports API - GET all reports

Lists all available reports of the specified type.

The request produces an application/json payload.

Early Adopter

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/reports
  • SaaS https://{your-environment-id}.live.dynatrace.com/api/config/v1/reports
  • Environment ActiveGate https://{your-activegate-domain}/e/{your-environment-id}/api/config/v1/reports

Authentication

To execute this request, you need the Read configuration (ReadConfig) permission assigned to your API token. To learn how to obtain and use it, see Tokens and authentication.

Parameters

Parameter Type Description In Required
type string

Type of a report.

query optional
sourceId string

Referencing source entity of a report (e.g. dashboard).

query optional

Response

Response codes

Code Description
200

Success

Response body

The ReportStubList object

A list of short representations of reports.

Element Type Description
values DashboardReportStub[]

A list of reports.

The DashboardReportStub object

A short representations of the report.

Element Type Description
id string

The ID of the report.

type string

The type of the report.

dashboardId string

The ID of the associated dashboard.

Example

In this example, the request asks for a list of all the report configurations in the mySampleEnv environment.

The API token is passed in the Authorization header.

The result is truncated to three entries.

Curl

curl -X GET \
  https://mySampleEnv.live.dynatrace.com/api/config/v1/reports/ \
  -H 'Accept: application/json; charset=utf-8' \
  -H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'

Request URL

https://mySampleEnv.live.dynatrace.com/api/config/v1/reports/

Response body

{
  "values": [
    {
      "id": "3ad7dece-98a4-4cc4-8805-34dcd19d4714",
      "type": "DASHBOARD",
      "dashboardId": "18d5b111-05ed-4efb-8cf1-e8dd0a9e5c47"
    },
    {
      "id": "81c86de0-95d6-42d1-ad50-8578bb688b1c",
      "type": "DASHBOARD",
      "dashboardId": "bf0aad45-3785-444f-88d3-21e547eb78b1"
    },
    {
      "id": "0b2e3121-4f8d-4b08-a879-3047e044ba4c",
      "type": "DASHBOARD",
      "dashboardId": "b6570e01-1d49-4bcc-a3bb-2fab2906512c"
    }
  ]
}

Response code

200