Try it free

Get an analyzer definition

  • Latest Dynatrace
  • Reference
  • Published Oct 13, 2026

Get an analyzer definition in Dynatrace with the Davis AI Predictive and Causal API and retrieve all available meta-information for the named analyzer.

GETSaaShttps://{your-environment-id}.apps.dynatrace.com/platform/davis/analyzers/v1/analyzers/{analyzer-name}

Overview

You provide the analyzer-name path parameter to identify the analyzer definition you want. The response returns the definition of the requested analyzer.

Authentication

To execute this request, you need a platform token or OAuth access token with davis:analyzers:read scope. To learn how to obtain and use it, see Tokens and authentication.

Parameters

ParameterTypeDescriptionInRequired
analyzer-namestring

The name of the analyzer.

pathRequired

Response

Response codes

CodeTypeDescription
200AnalyzerDefinition

The definition of the requested analyzer.

400AnalyzerErrorEnvelope

Invalid or malformed request.

403AnalyzerErrorEnvelope

Insufficient permissions.

404AnalyzerErrorEnvelope

No analyzer available with the requested name.

4XXAnalyzerErrorEnvelope

Client error.

5XXAnalyzerErrorEnvelope

Internal server error.

Response body objects

The AnalyzerDefinition object

The definition of the analyzer. It describes which input and output data the analyzer accepts and produces when being executed.

ElementTypeDescription
namestring

The uniquely identifying name of the analyzer.

displayNamestring-
descriptionstring

Detailed description of the analyzers' functionality. Get the documentation of the analyzer for more information.

categoryAnalyzerCategory

The category of an analyzer used to logically group different analyzers.

typestring

The type of the analyzer.

  • IMPLEMENTED: Analyzers which have an implementation and can be executed.
  • INTERFACE: Just an interface to be implemented or extended by other analyzer definitions.
The element can hold these values
  • IMPLEMENTED
  • INTERFACE
labelsstring[]

A list of string-based labels to group and mark different analyzers.

baseAnalyzerstring

The analyzer name that the current analyzer is based on. All input and output parameters are inherited. Additional parameters may be present in the current analyzer.

inputParameterDefinition[]-
outputParameterDefinition[]-

The AnalyzerCategory object

The category of an analyzer used to logically group different analyzers.

ElementTypeDescription
displayNamestring-

The ParameterDefinition object

The definition for a single parameter, describing its name and other meta information.

ElementTypeDescription
namestring-
typestring

The type of the parameter, indicating the format of the value to be provided.

The element can hold these values
  • analyzerStructure
  • boolean
  • dimensionQuery
  • enumeration
  • integer
  • number
  • string
  • timeframe
  • timeseriesArray
  • timeseriesQuery
  • timestamp
displayNamestring-
descriptionstring-
advancedboolean

If true, this parameter is considered to be for advanced usage.

extendedTypestring

Provides extended type information for this parameter. This allows additional semantics that can be utilized by analyzer consumers.

optionalboolean

Whether this parameter can be omitted when executing the analyzer.

arrayboolean

Whether this parameter can have an array of values. Passing a single, non-array value is also allowed.

defaultValue-

The default value used when the parameter is omitted.

maxSizeinteger

The maximum number of elements if the parameter is an array.

valueConstraintsobject

Defines value constraints for string or number parameters. Not applicable to other parameter types.

enumerationValuesEnumerationElement[]-
fieldsParameterDefinition[]

Given the parameter is of type structure this property contains the sub-definition of the parameter.

The EnumerationElement object

An object that has a fixed set of possible values differentiated by the key property.

ElementTypeDescription
keystring-
displayNamestring-
descriptionstring-

The AnalyzerErrorEnvelope object

ElementTypeDescription
errorAnalyzerError

The error that is returned for unsuccessful responses.

The AnalyzerError object

The error that is returned for unsuccessful responses.

ElementTypeDescription
codeinteger

The HTTP status code of the error.

messagestring-
detailsAnalyzerErrorDetails-

The AnalyzerErrorDetails object

ElementTypeDescription
constraintViolationsConstraintViolation[]-

The ConstraintViolation object

A constraint violation indicating why an error has occurred.

The AnalyzerExecutionLog object

ElementTypeDescription
levelAnalyzerExecutionLogLevel

Determines the severity of the log.

The element can hold these values
  • TRACING
  • INFO
  • WARNING
  • SEVERE
messagestring-
pathstring

A path pointing to the source of the error in the input. The format of the path follows the JSON path specification.

The AnalyzerExecutionLogLevel object

Determines the severity of the log.

Response body JSON models

{
  "name": "string",
  "displayName": "string",
  "description": "string",
  "category": {
    "displayName": "string"
  },
  "type": "IMPLEMENTED",
  "labels": [
    "string"
  ],
  "baseAnalyzer": "string",
  "input": [
    {
      "name": "string",
      "type": "analyzerStructure",
      "displayName": "string",
      "description": "string",
      "advanced": true,
      "extendedType": "string",
      "optional": true,
      "array": true,
      "defaultValue": {},
      "maxSize": 1,
      "valueConstraints": {},
      "enumerationValues": [
        {
          "key": "string",
          "displayName": "string",
          "description": "string"
        }
      ],
      "fields": [
        {}
      ]
    }
  ],
  "output": [
    {}
  ]
}
{
  "error": {
    "code": 400,
    "message": "string",
    "details": {
      "constraintViolations": [
        {
          "level": "TRACING",
          "message": "string",
          "path": "string"
        }
      ]
    }
  }
}
Related tags
Platform APIDynatrace PlatformAI Observability