Settings API - Ingest pipelines configuration schema table

  • Published Aug 25, 2025

Ingest pipelines configuration (builtin:openpipeline.metrics.pipelines)

Contains configuration of pipelines

Schema IDSchema groupsScope
builtin:openpipeline.metrics.pipelines-
environment
GETManagedhttps://{your-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:openpipeline.metrics.pipelines
SaaShttps://{your-environment-id}.live.dynatrace.com/api/v2/settings/schemas/builtin:openpipeline.metrics.pipelines
Environment ActiveGatehttps://{your-activegate-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:openpipeline.metrics.pipelines

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
Custom pipeline id
customId		text-required
Display name
displayName		text-required
Processing stage
processing		Stage-required
Security context stage
securityContext		Stage-required
Cost allocation stage
costAllocation		Stage-required
Product allocation stage
productAllocation		Stage-required
Storage stage
storage		Stage-required
Metrics extraction stage
metricExtraction		Stage-required
Davis event extraction stage
davis		Stage-required
Data extraction stage
dataExtraction		Stage-required
The Stage object
PropertyTypeDescriptionRequired
Processors of stage
processors		Processor[]-required
The Processor object
PropertyTypeDescriptionRequired
Processor identifier
id		text-required
Type
type		enum

Processor type

  • fieldsAdd
  • fieldsRemove
  • fieldsRename
  • dql
  • technology
  • drop
  • bucketAssignment
  • noStorage
  • securityContext
  • counterMetric
  • samplingAwareCounterMetric
  • valueMetric
  • histogramMetric
  • samplingAwareValueMetric
  • davis
  • bizevent
  • azureLogForwarding
  • securityEvent
  • costAllocation
  • productAllocation
required
Matcher (DQL)
matcher		text

See our documentation

required
Description
description		text-required
Sample data
sampleData		text-optional
Enabled
enabled		boolean-required
DQL processor attributes
dql		DqlAttributes-required
Fields add processor attributes
fieldsAdd		FieldsAddAttributes-required
Fields rename processor attributes
fieldsRename		FieldsRenameAttributes-required
Fields remove processor attributes
fieldsRemove		FieldsRemoveAttributes-required
Technology processor attributes
technology		TechnologyAttributes-required
Bucket assignment processor attributes
bucketAssignment		BucketAssignmentAttributes-required
Security context processor attributes
securityContext		SecurityContextAttributes-required
Counter metric processor attributes
counterMetric		CounterMetricAttributes-required
Sampling-aware counter metric processor attributes
samplingAwareCounterMetric		SamplingAwareCounterMetricAttributes-required
Value metric processor attributes
valueMetric		ValueMetricAttributes-required
Histogram metric processor attributes
histogramMetric		HistogramMetricAttributes-required
Sampling aware value metric processor attributes
samplingAwareValueMetric		SamplingAwareValueMetricAttributes-required
Davis event extraction processor attributes
davis		DavisAttributes-required
Bizevent extraction processor attributes
bizevent		BizeventAttributes-required
Azure log forwarding processor attributes
azureLogForwarding		AzureLogForwardingAttributes-required
Security event extraction processor attributes
securityEvent		SecurityEventAttributes-required
Cost allocation processor attributes
costAllocation		CostAllocationAttributes-required
Product allocation processor attributes
productAllocation		ProductAllocationAttributes-required
The DqlAttributes object
PropertyTypeDescriptionRequired
DQL script
script		text-required
The FieldsAddAttributes object
PropertyTypeDescriptionRequired
Fields to Add
fields		FieldsAddAttributesEntry[]-required
The FieldsRenameAttributes object
PropertyTypeDescriptionRequired
Fields to rename
fields		FieldsRenameAttributesEntry[]-required
The FieldsRemoveAttributes object
PropertyTypeDescriptionRequired
Fields to remove
fields		set-required
The TechnologyAttributes object
PropertyTypeDescriptionRequired
Custom matcher
customMatcher		text

Custom matching condition which should be used instead of technology matcher.

optional
Technology ID
technologyId		text-required
The BucketAssignmentAttributes object
PropertyTypeDescriptionRequired
Bucket name
bucketName		text-required
The SecurityContextAttributes object
PropertyTypeDescriptionRequired
Security context value assignment
value		GenericValueAssignment-required
The CounterMetricAttributes object
PropertyTypeDescriptionRequired
Metric key
metricKey		text-required
List of dimensions
dimensions		Set<FieldExtractionEntry>-required
The SamplingAwareCounterMetricAttributes object
PropertyTypeDescriptionRequired
Metric key
metricKey		text-required
List of dimensions
dimensions		Set<FieldExtractionEntry>-required
Sampling
sampling		enum
  • disabled
  • enabled
optional
Aggregation
aggregation		enum
  • disabled
  • enabled
optional
The ValueMetricAttributes object
PropertyTypeDescriptionRequired
Metric key
metricKey		text-required
Field with metric value
field		text-required
Default value with metric value
defaultValue		text-optional
List of dimensions
dimensions		Set<FieldExtractionEntry>-required
The HistogramMetricAttributes object
PropertyTypeDescriptionRequired
Metric key
metricKey		text-required
Field with metric value
field		text-required
List of dimensions
dimensions		Set<FieldExtractionEntry>-required
The SamplingAwareValueMetricAttributes object
PropertyTypeDescriptionRequired
Metric key
metricKey		text-required
Field with metric value
field		text-optional
Default value with metric value
defaultValue		text-optional
List of dimensions
dimensions		Set<FieldExtractionEntry>-required
Sampling
sampling		enum
  • disabled
  • enabled
optional
Aggregation
aggregation		enum
  • disabled
  • enabled
optional
Measurement
measurement		enum
  • field
  • duration
required
The DavisAttributes object
PropertyTypeDescriptionRequired
Properties
properties		DavisEventProperty[]-required
The BizeventAttributes object
PropertyTypeDescriptionRequired
Event type
eventType		GenericValueAssignment-optional
Event provider
eventProvider		GenericValueAssignment-required
Field extraction
fieldExtraction		FieldExtraction-required
The AzureLogForwardingAttributes object
PropertyTypeDescriptionRequired
ForwarderConfigId
forwarderConfigId		text-required
Field Extraction
fieldExtraction		FieldExtraction-required
The SecurityEventAttributes object
PropertyTypeDescriptionRequired
Field Extraction
fieldExtraction		FieldExtraction-required
The CostAllocationAttributes object
PropertyTypeDescriptionRequired
The strategy to set the cost allocation field
value		GenericValueAssignment-required
The ProductAllocationAttributes object
PropertyTypeDescriptionRequired
The strategy to set product allocation field
value		GenericValueAssignment-required
The FieldsAddAttributesEntry object
PropertyTypeDescriptionRequired
Fields's name
name		text-required
Field's value
value		text-required
The FieldsRenameAttributesEntry object
PropertyTypeDescriptionRequired
Fields's name
fromName		text-required
New field's name
toName		text-required
The GenericValueAssignment object
PropertyTypeDescriptionRequired
Type of value assignment
type		enum
  • constant
  • multiValueConstant
  • field
required
Constant value
constant		text-required
Constant multi value
multiValueConstant		list-required
Value from field
field		ValueAssignmentFromFieldEntry-required
The FieldExtractionEntry object
PropertyTypeDescriptionRequired
Source field name
sourceFieldName		text-required
Destination field name
destinationFieldName		text-optional
Default value
defaultValue		text-optional
The DavisEventProperty object
PropertyTypeDescriptionRequired
Key
key		text-required
Value
value		text-required
The FieldExtraction object
PropertyTypeDescriptionRequired
Fields Extraction type
type		enum
  • include
  • exclude
  • includeAll
required
Fields
include		Set<FieldExtractionEntry>-required
Fields
exclude		set-required
The ValueAssignmentFromFieldEntry object
PropertyTypeDescriptionRequired
Source field name
sourceFieldName		text-required
Default value
defaultValue		text-optional