Reports API - POST a report

Creates a new report.

The request consumes and produces an application/json payload.

POSTSaaShttps://{your-environment-id}.live.dynatrace.com/api/config/v1/reports
Environment ActiveGatehttps://{your-activegate-domain}:9999/e/{your-environment-id}/api/config/v1/reports

Authentication

To execute this request, you need an access token with WriteConfig scope.

To learn how to obtain and use it, see Tokens and authentication.

Parameters

Parameter
Type
Description
In
Required
body

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

body
optional

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

The ID of the report.

optional
subscriptions

A list of the report subscribers.

required
type
string
-
  • DASHBOARD
required

The DashboardReportSubscription object

A list of the report subscribers.

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

Request body JSON model

This is a model of the request body, showing the possible elements. It has to be adjusted for usage in an actual request.

{
  "dashboardId": "8dd67562-8bf5-4a09-830d-4e0ca992abd6",
  "enabled": "true",
  "id": "337d883e-98c3-4dac-b8f2-1a9cdbd05969",
  "subscriptions": {
    "MONTH": [
      "demo@email.com",
      "demo2@email.com"
    ],
    "WEEK": [
      "demo@email.com"
    ]
  },
  "type": "DASHBOARD"
}

Response

Response codes

Code
Type
Description
201

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

400

Failed. The input is invalid.

Response body objects

The EntityShortRepresentation object

The short representation of a Dynatrace entity.

Element
Type
Description
description
string

A short description of the Dynatrace entity.

id
string

The ID of the Dynatrace entity.

name
string

The name of the Dynatrace entity.

Response body JSON model

{
  "description": "Dynatrace entity for the REST API example",
  "id": "6a98d7bc-abb9-44f8-ae6a-73e68e71812a",
  "name": "Dynatrace entity"
}

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.

POSTSaaShttps://{your-environment-id}.live.dynatrace.com/api/config/v1/reports/validator
Environment ActiveGatehttps://{your-activegate-domain}:9999/e/{your-environment-id}/api/config/v1/reports/validator

Authentication

To execute this request, you need an access token with WriteConfig scope.

To learn how to obtain and use it, see Tokens and authentication.

Response

Response codes

Code
Type
Description
204
-

Validated. The submitted report is valid. The response doesn't have a body.

400

Failed. The input is invalid.

Example

In this example, the request creates a new report for the dashboard with the ID of 2768e6ca-e199-4433-9e0d-2922aec2099b.

The report is sent weekly to Dynatrace user john.smith and monthly to Dynatrace user jane.brown.

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 that are available in your environment.

Curl

curl -X POST \
  https://mySampleEnv.live.dynatrace.com/api/config/v1/reports \
  -H 'Accept: application/json' \
  -H 'Authorization: Api-Token dt0c01.abc123.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

Request body

{
  "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

204

Related topics