Web application configuration API - POST key user actions

Adds a user action to the list of key user actions in the specified application.

The request consumes and produces an application/json payload.

Early Adopter

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

Authentication

To execute this request, you need the Write configuration (WriteConfig) permission assigned to your API token. To learn how to obtain and use it, see Tokens and authentication.

Parameters

Parameter Type Description In Required
id string

The ID of the web application, where you want to set the user action as a key user action.

path required
body KeyUserAction

JSON body of the request, containing the name, type and domain of the user action to be marked as key user action.

body optional

The KeyUserAction object

Element Type Description Required
name string

The name of the user action.

required
actionType string

The actionType of the user action.

The actionType element can hold these values.
required
domain string

The domain of the user action.

optional
meIdentifier string

The identifier of the user action.

optional

Possible values

Possible values for the actionType element in the KeyUserAction object:

  • Custom
  • Load
  • Xhr

Response codes

Code Description
201 Success. User action marked as key user action. The response contains the MEIdentifier of the new key user action.
400 Failed. The input is invalid.

Response format

The EntityShortRepresentation object

The short representation of a Dynatrace entity.

Element Type Description Required
id string

The ID of the Dynatrace entity.

required
name string

The name of the Dynatrace entity.

optional
description string

A short description of the Dynatrace entity.

optional