Web application configuration API - POST a key user action

  • Reference
  • Published Sep 24, 2020

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

The request consumes and produces an application/json payload.

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

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

ParameterTypeDescriptionInRequired
idstring

The ID of the required web application.

pathrequired
bodyKeyUserAction

The JSON body of the request. Contains the action to be marked as a key user action.

bodyoptional

Request body objects

The KeyUserAction object

Configuration of the key user action.

ElementTypeDescriptionRequired
actionTypestring

The type of the action.

  • Custom
  • Load
  • Xhr
required
domainstring

The domain where the action is performed.

optional
meIdentifierstring

The Dynatrace entity ID of the action.

optional
namestring

The name of the action.

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.

{
"actionType": "Load",
"domain": "test.com",
"name": "Loading of page /example"
}

Response

Response codes

CodeTypeDescription
201EntityShortRepresentation

Success. The action has been marked as a key user action. The response contains its ID.

400ErrorEnvelope

Failed. The input is invalid.

Response body objects

The EntityShortRepresentation object

The short representation of a Dynatrace entity.

ElementTypeDescription
descriptionstring

A short description of the Dynatrace entity.

idstring

The ID of the Dynatrace entity.

namestring

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