Reports API - GET a report
Gets the properties of the specified report.
The request produces an application/json payload.
| GET | ManagedDynatrace for Government | https://{your-domain}/e/{your-environment-id}/api/config/v1/reports/{id} |
| SaaS | https://{your-environment-id}.live.dynatrace.com/api/config/v1/reports/{id} | |
| Environment ActiveGate | https://{your-activegate-domain}:9999/e/{your-environment-id}/api/config/v1/reports/{id} |
Authentication
To execute this request, you need an access token with ReadConfig scope.
To learn how to obtain and use it, see Tokens and authentication.
Parameters
| Parameter | Type | Description | In | Required |
|---|---|---|---|---|
| id | string | The ID of the required report. | path | required |
Response
Response codes
| Code | Type | Description |
|---|---|---|
| 200 | DashboardReport | Success. The response body contains parameters of the report. |
Response body objects
The DashboardReport object
Configuration of a dashboard report.
The dashboard report provides a public link to the associated dashboard with a custom reporting period: last week for weekly subscribers or last month for monthly subscribers.
| Element | Type | Description |
|---|---|---|
| dashboardId | string | The ID of the associated dashboard. |
| enabled | boolean | The email notifications for the dashboard report are enabled ( |
| id | string | The ID of the report. |
| subscriptions | DashboardReportSubscription | A list of the report subscribers. |
| type | string | -
|
The DashboardReportSubscription object
A list of the report subscribers.
| Element | Type | Description |
|---|---|---|
| MONTH | string[] | A list of monthly subscribers. Monthly subscribers receive the report on the first Monday of the month at midnight. You can specify email addresses or Dynatrace user IDs here. |
| WEEK | string[] | A list of weekly subscribers. Weekly subscribers receive the report every Monday at midnight. You can specify email addresses or Dynatrace user IDs here. |
Response body JSON model
1{2 "dashboardId": "8dd67562-8bf5-4a09-830d-4e0ca992abd6",3 "enabled": "true",4 "id": "337d883e-98c3-4dac-b8f2-1a9cdbd05969",5 "subscriptions": {6 "MONTH": [7 "demo@email.com",8 "demo2@email.com"9 ],10 "WEEK": [11 "demo@email.com"12 ]13 },14 "type": "DASHBOARD"15}
Example
In this example, the request inquires about the properties of the report with the ID of 0b2e3121-4f8d-4b08-a879-3047e044ba4c.
The report contains data from the dashboard with the ID of b6570e01-1d49-4bcc-a3bb-2fab2906512c. It is sent weekly to Dynatrace users john.smith and ryan.white and monthly to Dynatrace user jane.brown and also to the marketing.office@organization.com email address.
The API token is passed in the Authorization header.
Curl
1curl -X GET \2 https://mySampleEnv.live.dynatrace.com/api/config/v1/reports/0b2e3121-4f8d-4b08-a879-3047e044ba4c \3 -H 'Accept: application/json; charset=utf-8' \4 -H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'
Request URL
1https://mySampleEnv.live.dynatrace.com/api/config/v1/reports/0b2e3121-4f8d-4b08-a879-3047e044ba4c
Response body
1{2 "id": "0b2e3121-4f8d-4b08-a879-3047e044ba4c",3 "type": "DASHBOARD",4 "dashboardId": "b6570e01-1d49-4bcc-a3bb-2fab2906512c",5 "enabled": true,6 "subscriptions": {7 "WEEK": [8 "john.smith",9 "ryan.white"10 ],11 "MONTH": [12 "jane.brown",13 "marketing.office@organization.com"14 ]15 }16}
Response code
200