Get an analyzer result JSON schema in Dynatrace with the Davis AI Predictive and Causal API to document the analyzer output structure in machine-readable form.
| GET | SaaS | https://{your-environment-id}.apps.dynatrace.com/platform/davis/analyzers/v1/analyzers/{analyzer-name}/json-schema/result |
You provide the analyzer-name path parameter and can use config to shape JSON schema generation. The response returns the JSON result schema 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 |
| config | Json | The configuration for the JSON schema generation. The element can hold these values
| query | Optional |
| Code | Type | Description |
|---|---|---|
| 200 | object | The JSON result schema 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.
{"title": "Result for Generic Forecast Analysis","$schema": "http://json-schema.org/draft-07/schema#","description": "Forecast of a time series","type": "object","additionalProperties": false,"required": ["resultStatus","executionStatus","resultId","output"],"properties": {"resultStatus": {"title": "resultStatus","x-parameter-type": "enumeration","type": "string","anyOf": [{"title": "Successful","description": "Successful result","enum": ["SUCCESSFUL"]},{"title": "Successful with warnings","description": "Successful result contains warnings","enum": ["SUCCESSFUL_WITH_WARNINGS"]},{"title": "Failed","description": "Failed result","enum": ["FAILED"]}]},"executionStatus": {"title": "executionStatus","x-parameter-type": "enumeration","type": "string","anyOf": [{"title": "Running","description": "Execution still running","enum": ["RUNNING"]},{"title": "Aborted","description": "Execution manually canceled","enum": ["ABORTED"]},{"title": "Completed","description": "Execution completed","enum": ["COMPLETED"]}]},"resultId": {"title": "resultId","x-parameter-type": "string","type": "string"},"input": {"type": "object","additionalProperties": false,"required": ["timeSeriesData"],"properties": {"generalParameters": {"title": "General parameters","description": "Parameters available for each analyzer.","default": {"timeframe": {},"resolveDimensionalQueryData": false,"logVerbosity": "WARNING"},"x-parameter-type": "analyzerStructure","type": "object","additionalProperties": false,"properties": {"timeframe": {"title": "Timeframe","description": "By default, the general timeframe for queries is the last 2 hours from now.","default": {},"x-parameter-type": "timeframe","type": "object","additionalProperties": false,"properties": {"startTime": {"title": "Start time","description": "Supports absolute or relative timestamps. Specify an absolute time in the ISO 8601 (yyyy-MM-ddTHH:mm:ssZ) format or use a relative time such as 'now-2h'.","type": "string","format": "dt-date-time","examples": ["2023-04-10T12:00:00Z"],"default": "now-2h"},"endTime": {"title": "End time","type": "string","format": "dt-date-time","examples": ["2023-04-12T12:00:00Z"],"default": "now"}},"required": ["startTime"],"examples": [{"startTime": "2023-04-10T12:00Z"},{"startTime": "2023-04-10T12:00Z","endTime": "2023-04-12T12:00Z"}]},"resolveDimensionalQueryData": {"title": "Resolve data","description": "Include output query results in analysis result.","default": false,"x-parameter-type": "boolean","type": "boolean"},"logVerbosity": {"title": "Log verbosity","description": "Controls the level of log details in analysis result.","default": "WARNING","x-parameter-type": "enumeration","type": "string","anyOf": [{"title": "Tracing","description": "Tracing","enum": ["TRACING"]},{"title": "Info","description": "Info","enum": ["INFO"]},{"title": "Warning","description": "Warning","enum": ["WARNING"]},{"title": "Severe","description": "Severe","enum": ["SEVERE"]}]}}},"timeSeriesData": {"title": "Time series data","description": "Time series data or query to analyze. Supports the Dynatrace Query Language (DQL).","x-parameter-type": "timeseriesQuery","type": "string"},"coverageProbability": {"title": "Coverage probability","description": "The forecast's targeted coverage probability. Defines how many of the observations (in percent) lie within the prediction interval.","default": 0.9,"x-parameter-type": "double","type": "number","minimum": 0,"maximum": 1},"forecastHorizon": {"title": "Data points to predict","description": "Total steps the time series is forecasted. More steps generally results in less reliable forecasts and longer analyzer runtimes.","default": 100,"x-parameter-type": "integer","type": "integer","minimum": 1,"maximum": 600},"nPaths": {"title": "Number of paths","description": "Total simulated paths. As the forecasting algorithm uses a simulation-based approach, more paths generally result in more accurate forecasts but can increase analyzer runtimes.","default": 200,"x-parameter-type": "integer","type": "integer","minimum": 0,"maximum": 1000},"applyZeroLowerBoundHeuristic": {"title": "Apply zero lower bound heuristic","description": "Apply a lower bound of zero.","default": false,"x-parameter-type": "boolean","type": "boolean"},"useModelCache": {"title": "Trained model is stored","description": "If true, the trained model is stored in and loaded from the model store. If false, a new model will be trained.","default": true,"x-parameter-type": "boolean","type": "boolean"}}},"output": {"type": "array","items": {"type": "object","additionalProperties": false,"required": ["analysisStatus"],"properties": {"message": {"title": "message","x-parameter-type": "string","type": "string"},"detailedDescription": {"title": "detailedDescription","x-parameter-type": "string","type": "string"},"system": {"title": "System","description": "Output system parameters","x-parameter-type": "analyzerStructure","type": "object","additionalProperties": false,"properties": {"logs": {"title": "Logs","description": "Logs connected to a specific output","x-parameter-type": "analyzerStructure","type": "array","items": {"type": "object","additionalProperties": false,"required": ["level","message"],"properties": {"level": {"title": "Level","x-parameter-type": "enumeration","type": "string","anyOf": [{"title": "Tracing","description": "Tracing","enum": ["TRACING"]},{"title": "Info","description": "Info","enum": ["INFO"]},{"title": "Warning","description": "Warning","enum": ["WARNING"]}]},"message": {"title": "Message","x-parameter-type": "string","type": "string"}}}}}},"analysisStatus": {"title": "The status of an analysis","description": "The status of an analysis of a particular univariate data","x-parameter-type": "enumeration","type": "string","anyOf": [{"title": "OK","description": "The analysis was performed successfully, the result is available.","enum": ["OK"]},{"title": "Failed","description": "There was a problem during an analysis, the result is not available","enum": ["FAILED"]}]},"analyzedTimeSeriesQuery": {"title": "Analyzed time series query","description": "Time series query that was analyzed.","x-parameter-type": "timeseriesQuery","type": "string"},"forecastQualityAssessment": {"title": "Forecast quality assessment explanation","description": "An assessment of the forecast's quality. 'valid' if forecast quality is eligible, otherwise the forecast is 'invalid' and the reason for this assessment is returned.","x-parameter-type": "enumeration","type": "string","anyOf": [{"title": "Valid forecast","description": "The quality of the forecast is deemed good.","enum": ["VALID"]},{"title": "Invalid forecast","description": "The quality of the forecast is deemed bad.","enum": ["INVALID"]}]},"timeSeriesDataWithPredictions": {"title": "Timeseries Data with predictions","description": "Time series array with predicted data points. Has properties {dt.davis.forecast: lower, dt.davis.forecast: point, dt.davis.forecast: upper} on the respective columns.","x-parameter-type": "timeseriesArray","type": "object"}}}},"logs": {"type": "array","items": {"level": {"title": "level","x-parameter-type": "enumeration","type": "string","anyOf": [{"title": "Tracing","description": "Tracing","enum": ["TRACING"]},{"title": "Info","description": "Info","enum": ["INFO"]},{"title": "Warning","description": "Warning","enum": ["WARNING"]},{"title": "Severe","description": "Severe","enum": ["SEVERE"]}]},"message": {"title": "message","x-parameter-type": "string","type": "string"}}}}}
{"error": {"code": 400,"message": "string","details": {"constraintViolations": [{"level": "TRACING","message": "string","path": "string"}]}}}