Reports API - PUT a report

Updates the specified report. If a report with the specified ID doesn't exist, a new one is created.

The request consumes and produces an application/json payload.

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

PUT
  • 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 report to be updated.

The ID in the request body must match this ID.

path required
body DashboardReport

The JSON body of the request. Contains updated parameters of the report.

body optional

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

The ID of the report.

optional
type string The type element can hold these values. required
dashboardId string

The ID of the associated dashboard.

required
enabled boolean

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

optional
subscriptions DashboardReportSubscription

A list of the report subscribers.

required

The DashboardReportSubscription object

A list of the report subscribers.

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

optional
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.

optional

Possible values

Possible values for the type element in the DashboardReport object:

  • DASHBOARD

Response format

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.

Response codes

Code Description
201

Success. The new report has been created. The response contains the ID of the new report.

204

Success. The report has been updated. Response doesn't have a body

400

Failed. The input is invalid.

Validate payload

We recommend that you validate the payload before submitting it with an actual request. A response code of 204 indicates a valid payload.

The request consumes an application/json payload.

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

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

Response codes

Code Description
204 Validated. The submitted report is valid. Response doesn't have a body
400 Failed. The input is invalid.

Example

In this example, the request updates the report from the POST request example. It adds the following subscribers:

  • Weekly for operations@organization.com address.
  • Monthly for cto@organization.com address.

Note that all existing subscribers must be present in the request body. Existing subscribers not present in the request body are removed.

The API token is passed in the Authorization header.

You can download or copy the example request body to try it out on your own. Be sure to use the dashboard ID and user IDs that are available in your environment

Curl

curl -X PUT \
  https://mySampleEnv.live.dynatrace.com/api/config/v1/reports/f78f78f5-00bd-4cc1-9e8b-ecfd1e379a73 \
  -H 'Accept: application/json' \  
  -H 'Authorization: Api-token abcdefjhij1234567890' \
  -H 'Content-Type: application/json' \
  -d '{
    "type": "DASHBOARD",
    "dashboardId": "2768e6ca-e199-4433-9e0d-2922aec2099b",
    "enabled": "true",
    "subscriptions": {
      "WEEK": [
        "john.smith"
      ],
      "MONTH": [
        "jane.brown"
      ]
    }
  }
'

Request URL

https://mySampleEnv.live.dynatrace.com/api/config/v1/reports/f78f78f5-00bd-4cc1-9e8b-ecfd1e379a73

Request body

api-examples/config/repots/post.json
Download
{
  "type": "DASHBOARD",
  "dashboardId": "2768e6ca-e199-4433-9e0d-2922aec2099b",
  "enabled": "true",
  "subscriptions": {
    "WEEK": [
      "john.smith"
    ],
    "MONTH": [
      "jane.brown"
    ]
  }
}

Response body

{
  "id": "f78f78f5-00bd-4cc1-9e8b-ecfd1e379a73"
}

Response code

201