Applications API - GET baseline

  • Reference
  • Deprecated

Gets the baseline data of the specified application.

The request produces an application/json payload.

GETSaaShttps://{your-environment-id}.live.dynatrace.com/api/v1/entity/applications/{meIdentifier}/baseline
Environment ActiveGatehttps://{your-activegate-domain}:9999/e/{your-environment-id}/api/v1/entity/applications/{meIdentifier}/baseline

Authentication

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

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

Parameters

ParameterTypeDescriptionInRequired
meIdentifierstring

The Dynatrace entity ID of the required application.

pathRequired

Response

Response codes

CodeTypeDescription
200ApplicationBaselineValues

Success

4XXErrorEnvelope

Client side error.

5XXErrorEnvelope

Server side error.

Response body objects

The ApplicationBaselineValues object

The baseline data for an application and its children for each available duration metric.

A duration metric is one of the following:

  • DOM interactive
  • HTML downloaded
  • Load event end
  • Load event start
  • Response time
  • Speed index
  • Time to first byte
  • Visually complete
ElementTypeDescription
applicationDomInteractiveBaselinesEntityBaselineData[]

The baseline data for the DOM interactive duration metric.

applicationHtmlDownloadedBaselinesEntityBaselineData[]

The baseline data for the HTML downloaded duration metric.

applicationLoadEventEndBaselinesEntityBaselineData[]

The baseline data for the Load event end duration metric.

applicationLoadEventStartBaselinesEntityBaselineData[]

The baseline data for the Load event start duration metric.

applicationResponseTimeBaselinesEntityBaselineData[]

The baseline data for the Response time duration metric.

applicationSpeedIndexBaselinesEntityBaselineData[]

The baseline data for the Speed index duration metric.

applicationTimeToFirstByteBaselinesEntityBaselineData[]

The baseline data for the Time to first byte duration metric.

applicationVisualCompleteBaselinesEntityBaselineData[]

The baseline data for the Visually complete duration metric.

displayNamestring

The name of the application as displayed in the UI.

entityIdstring

The Dynatrace entity ID of the application.

The EntityBaselineData object

The baseline data for a Dynatrace entity for a specific duration metric.

ElementTypeDescription
childBaselinesEntityBaselineData[]

The baseline data for child entities of this entity, for example a SERVICE_METHOD of a SERVICE_METHOD_GROUP.

displayNamestring

The display name of the entity.

entityIdstring

The ID of the Dynatrace entity.

errorRatenumber

The error rate baseline.

hasLoadBaselineboolean

The entity has a load baseline (true) or doesn't (false).

micros90thPercentilenumber

The 90th percentile baseline, in microseconds.

microsMediannumber

The median baseline, in microseconds.

The ErrorEnvelope object

ElementTypeDescription
errorError-

The Error object

ElementTypeDescription
codeinteger

The HTTP status code

constraintViolationsConstraintViolation[]

A list of constraint violations

messagestring

The error message

The ConstraintViolation object

A list of constraint violations

ElementTypeDescription
locationstring-
messagestring-
parameterLocationstring-
The element can hold these values
  • HEADER
  • PATH
  • PAYLOAD_BODY
  • QUERY
pathstring-

Response body JSON models

{
  "applicationDomInteractiveBaselines": [
    {
      "childBaselines": [
        {}
      ],
      "displayName": "string",
      "entityId": "string",
      "errorRate": 1,
      "hasLoadBaseline": true,
      "micros90thPercentile": 1,
      "microsMedian": 1
    }
  ],
  "applicationHtmlDownloadedBaselines": [
    {}
  ],
  "applicationLoadEventEndBaselines": [
    {}
  ],
  "applicationLoadEventStartBaselines": [
    {}
  ],
  "applicationResponseTimeBaselines": [
    {}
  ],
  "applicationSpeedIndexBaselines": [
    {}
  ],
  "applicationTimeToFirstByteBaselines": [
    {}
  ],
  "applicationVisualCompleteBaselines": [
    {}
  ],
  "displayName": "string",
  "entityId": "string"
}
{
  "error": {
    "code": 1,
    "constraintViolations": [
      {
        "location": "string",
        "message": "string",
        "parameterLocation": "HEADER",
        "path": "string"
      }
    ],
    "message": "string"
  }
}