Validate analyzer input in Dynatrace with the Davis AI Predictive and Causal API before execution, using the same input you plan to run.
| POST | SaaS | https://{your-environment-id}.apps.dynatrace.com/platform/davis/analyzers/v1/analyzers/{analyzer-name}:validate |
You provide the analyzer-name path parameter and the input you plan to use for execution. The response returns the validation result for the requested analyzer execution.
To execute this request, you need a platform token or OAuth access token with davis:analyzers:execute 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 |
| body | Analyzer | The map of actual data matching the input and output definition of the analyzer. | body | Required |
AnalyzerData objectThe map of actual data matching the input and output definition of the analyzer.
| Element | Type | Description | Required |
|---|---|---|---|
| generalParameters | Analyzer | Parameters that are present in all analyzer input parameter definitions. | Optional |
AnalyzerGeneralParameters objectParameters that are present in all analyzer input parameter definitions.
| Element | Type | Description | Required |
|---|---|---|---|
| timeframe | Timeframe | - | Optional |
| resolveDimensionalQueryData | boolean | - | Optional |
| logVerbosity | Analyzer | Determines the severity of the log. The element can hold these values
| Optional |
Timeframe object| Element | Type | Description | Required |
|---|---|---|---|
| startTime | string | Specify the start time in either absolute or relative format. For absolute format, use the ISO 8601 format (yyyy-MM-ddTHH:mm:ssZ). For relative format, use 'now' for the current time or apply an offset with the available units: 's' for seconds, 'm' for minutes, 'h' for hours, and 'd' for days. For example, use 'now-2h' or '-2h' for a relative offset of 2 hours. | Required |
| endTime | string | Specify the end time in either absolute or relative format. For absolute format, use the ISO 8601 format (yyyy-MM-ddTHH:mm:ssZ). For relative format, use 'now' for the current time or apply an offset with the available units: 's' for seconds, 'm' for minutes, 'h' for hours, and 'd' for days. For example, use 'now-2h' or '-2h' for a relative offset of 2 hours. If not specified, defaults to now. | Optional |
AnalyzerExecutionLogLevel objectDetermines the severity of the log.
This is a model of the request body, showing the possible elements. It has to be adjusted for usage in an actual request.
{"$ref": "#/components/examples/AnalyzerData"}
| Code | Type | Description |
|---|---|---|
| 200 | Analyzer | The validation result for the requested analyzer execution. |
| 400 | Analyzer | No analyzer available with the requested name. |
| 403 | Analyzer | Insufficient permissions. |
| 404 | Analyzer | Not found |
| 4XX | Analyzer | Client error. |
| 5XX | Analyzer | Internal server error. |
AnalyzerValidationResult objectThe result of the dry-execution of the analyzer.
| Element | Type | Description |
|---|---|---|
| valid | boolean | Whether the analyzer can be successfully executed with the given input data. |
| 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.
AnalyzerErrorEnvelope 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.
{"valid": true,"details": {"constraintViolations": [{"level": "TRACING","message": "string","path": "string"}]}}
{"error": {"code": 400,"message": "string","details": {"constraintViolations": [{"level": "TRACING","message": "string","path": "string"}]}}}