Get analyzer documentation in Dynatrace with the Davis AI Predictive and Causal API to retrieve Markdown guidance and context for a named analyzer.
| GET | SaaS | https://{your-environment-id}.apps.dynatrace.com/platform/davis/analyzers/v1/analyzers/{analyzer-name}/documentation |
You provide the analyzer-name path parameter to select the analyzer whose documentation you want. The response returns the documentation of the requested analyzer.
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.
| Parameter | Type | Description | In | Required |
|---|---|---|---|---|
| analyzer-name | string | The name of the analyzer. | path | Required |
| Code | Type | Description |
|---|---|---|
| 200 | string | The documentation of the requested analyzer. |
| 400 | Analyzer | Invalid or malformed request. |
| 403 | Analyzer | Insufficient permissions. |
| 404 | Analyzer | No analyzer available with the requested name. |
| 4XX | Analyzer | Client error. |
| 5XX | Analyzer | Internal server error. |
ResponseBody objectAnalyzerErrorEnvelope object| Element | Type | Description |
|---|---|---|
| error | Analyzer | The error that is returned for unsuccessful responses. |
AnalyzerError objectThe error that is returned for unsuccessful responses.
| Element | Type | Description |
|---|---|---|
| code | integer | The HTTP status code of the error. |
| message | string | - |
| details | Analyzer | - |
AnalyzerErrorDetails object| Element | Type | Description |
|---|---|---|
| constraintViolations | Constraint | - |
ConstraintViolation objectA constraint violation indicating why an error has occurred.
AnalyzerExecutionLog object| Element | Type | Description |
|---|---|---|
| level | Analyzer | Determines the severity of the log. The element can hold these values
|
| message | string | - |
| path | string | A path pointing to the source of the error in the input. The format of the path follows the JSON path specification. |
AnalyzerExecutionLogLevel objectDetermines the severity of the log.
{"error": {"code": 400,"message": "string","details": {"constraintViolations": [{"level": "TRACING","message": "string","path": "string"}]}}}