Reports API - GET a report

Gets the properties of the specified report.

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

Parameters

Parameter Type Description In Required
id string

The ID of the required report.

path required

Response format

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
id string

The ID of the report.

type string
dashboardId string

The ID of the associated dashboard.

enabled boolean

The email notifications for the dashboard report are enabled (true) or disabled (false).

subscriptions DashboardReportSubscription

The DashboardReportSubscription object

A list of the report subscribers.

Element Type Description
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.

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.

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

curl -X GET \
  https://mySampleEnv.live.dynatrace.com/api/config/v1/reports/0b2e3121-4f8d-4b08-a879-3047e044ba4c \
    -H 'Accept: application/json; charset=utf-8' \
    -H 'Authorization: Api-token abcdefjhij1234567890'

Request URL

https://mySampleEnv.live.dynatrace.com/api/config/v1/reports/0b2e3121-4f8d-4b08-a879-3047e044ba4c

Response body

{
    "id": "0b2e3121-4f8d-4b08-a879-3047e044ba4c",
    "type": "DASHBOARD",
    "dashboardId": "b6570e01-1d49-4bcc-a3bb-2fab2906512c",
    "enabled": true,
    "subscriptions": {
        "WEEK": [
            "john.smith",
            "ryan.white"
        ],
        "MONTH": [
            "jane.brown",
            "marketing.office@organization.com"
        ]
    }
}

Response code

200