Web application configuration API - POST a key user action
Adds a user action to the list of key user actions in the specified application.
The request consumes and produces an application/json
payload.
POST | ManagedDynatrace for Government | 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 | |
Environment ActiveGate | https://{your-activegate-domain}/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
Parameter | Type | Description | In | Required |
---|---|---|---|---|
id | string | The ID of the required web application. | path | required |
body | Key | The JSON body of the request. Contains the action to be marked as a key user action. | body | optional |
Request body objects
The KeyUserAction
object
Configuration of the key user action.
Element | Type | Description | Required |
---|---|---|---|
actionType | string | The type of the action. | required |
domain | string | The domain where the action is performed. | optional |
meIdentifier | string | The Dynatrace entity ID of the action. | optional |
name | string | 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
Code | Type | Description |
---|---|---|
201 | Entity | Success. The action has been marked as a key user action. The response contains its ID. |
400 | ErrorEnvelope | 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"
}