Settings API - Anomaly detectors schema table

  • Published May 20, 2024

Anomaly detectors (builtin:davis.anomaly-detectors)

Anomaly detectors are used to automatically detect anomalies in timeseries by using thresholds or baselines.

Schema IDSchema groupsScope
builtin:davis.anomaly-detectors
  • group:anomaly-detection
environment
GETManagedhttps://{your-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:davis.anomaly-detectors
SaaShttps://{your-environment-id}.live.dynatrace.com/api/v2/settings/schemas/builtin:davis.anomaly-detectors
Environment ActiveGatehttps://{your-activegate-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:davis.anomaly-detectors

Authentication

To execute this request, you need an access token with Read settings (settings.read) scope. To learn how to obtain and use it, see Tokens and authentication.

Parameters

PropertyTypeDescriptionRequired
Enabled
enabled		boolean

When enabled, the anomaly detector will be active and running.

required
Title
title		text

The title of the anomaly detector

required
Description
description		text

The description of the anomaly detector

required
Source
source		text

The source which created the anomaly detector

required
Execution settings
executionSettings		ExecutionSettings

Defines the configuration parameters that influence how and under what context a query or evaluation is executed.

required
Analyzer input
analyzer		AnalyzerInput

Analyzer input to initialize the analyzer

required
Event template
eventTemplate		DavisEventTemplate

Defines additional fields on the davis events triggered by the anomaly detector

required
The ExecutionSettings object
PropertyTypeDescriptionRequired
Actor
actor		text

UUID of a service user. Queries will be executed on behalf of the service user.

optional
Query offset
queryOffset		integer

Minute offset of sliding evaluation window for metrics with latency

optional
The AnalyzerInput object
PropertyTypeDescriptionRequired
Name
name		text

Fully qualified name of the analyzer

required
Input fields
input		Set<AnalyzerInputField>

Input fields for the specified analyzer

required
The DavisEventTemplate object
PropertyTypeDescriptionRequired
Event properties
properties		EventProperty[]

Set of additional key-value properties to be attached to the triggered event.

required
The AnalyzerInputField object
PropertyTypeDescriptionRequired
Key
key		text

Analyzer input field key

required
Value
value		text

Analyzer input field value

required
The EventProperty object
PropertyTypeDescriptionRequired
Key
key		text

Property key

required
Value
value		text

Property value. Supports substitution of placeholders placed in curly braces {}.

required