Settings API - Pipeline Groups configuration (metrics) schema table

  • Published Sep 25, 2025

Pipeline Groups configuration (metrics) (builtin:openpipeline.metrics.pipeline-groups)

Contains configuration of a pipeline group

Schema IDSchema groupsScope
builtin:openpipeline.metrics.pipeline-groups
  • group:openpipeline.all.pipeline-groups
environment
Retrieve schema via Settings API
GETManagedhttps://{your-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:openpipeline.metrics.pipeline-groups
GETSaaShttps://{your-environment-id}.live.dynatrace.com/api/v2/settings/schemas/builtin:openpipeline.metrics.pipeline-groups
GETEnvironment ActiveGatehttps://{your-activegate-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:openpipeline.metrics.pipeline-groups

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
Display name
displayName		text-Required
Pipelines wrapped by this group
memberPipelines		set-Required
stage configuration of the member pipelines
memberStages		StageConfig-Required
Composition
composition		PipelineGroupComposition[]-Required
The StageConfig object
PropertyTypeDescriptionRequired
Stage configuration type
type		enum
The element has these enums
  • include
  • exclude
  • includeAll
Required
include stages
include		Set<StageType>
The element has these enums
  • processing
  • securityContext
  • costAllocation
  • productAllocation
  • storage
  • smartscapeNodeExtraction
  • smartscapeEdgeExtraction
  • metricExtraction
  • davis
  • dataExtraction
Required
exclude stages
exclude		Set<StageType>
The element has these enums
  • processing
  • securityContext
  • costAllocation
  • productAllocation
  • storage
  • smartscapeNodeExtraction
  • smartscapeEdgeExtraction
  • metricExtraction
  • davis
  • dataExtraction
Required
The PipelineGroupComposition object
PropertyTypeDescriptionRequired
Placeholder for the wrapped pipeline
isPipelinePlaceholder		boolean-Required
Pipeline ID
pipelineId		text-Required
stage configuration for this pipelines
stages		StageConfig-Required