Reports API - POST subscribe to a report

Subscribes the specified users to the specified report. All existing subscriptions remain intact.

The request consumes and produces an application/json payload.

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

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

The ID of the report to subscribe to.

path
required
body

The JSON body of the request. Contains a list of new subscribers.

body
optional

Request body objects

The ReportSubscriptions object

Configuration of a report subscription.

Element
Type
Description
Required
recipients
string[]

A list of the recipients.

You can specify email addresses or Dynatrace user IDs here.

required
schedule
string

The schedule of the subscription.

  • Weekly subscribers receive the report every Monday at midnight.
  • Monthly subscribers receive the report on the first Monday of the month at midnight.
  • MONTH
  • WEEK
required

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.

{
  "recipients": [
    "demo@email.com",
    "demo2@email.com"
  ],
  "schedule": "WEEK"
}

Response

Response codes

Code
Type
Description
201

Success. The new subscriptions have been created. The response body contains the report ID.

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

Example

In this example, the request updates the report from the POST request example. It adds the weekly subscriptions for the Dynatrace user ryan.white.

The API token is passed in the Authorization header.

Curl

curl -X POST \
  https://mySampleEnv.live.dynatrace.com/api/config/v1/reports/f78f78f5-00bd-4cc1-9e8b-ecfd1e379a73/subscribe \
  -H 'Accept: application/json' \
  -H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890' \
  -H 'Content-Type: application/json' \
  -d '{
    "schedule": "WEEK",
    "recipients": [
      "ryan.white"
    ]
  }
'

Request URL

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

Request body

{
  "schedule": "WEEK",
  "recipients": [
    "ryan.white"
  ]
}

Response body

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

Response code

201

Related topics