Try it free

List filter segments in lean form

  • Latest Dynatrace
  • Reference
  • Published Oct 13, 2026

List filter segments in Dynatrace with the Grail Filter Segments API in a minimal form for faster responses, with optional additional fields.

GETSaaShttps://{your-environment-id}.apps.dynatrace.com/v1/filter-segments:lean

Overview

You use add-fields to request additional fields while listing filter segments in a minimal representational form. The operation returns all filter segments and is optimized for quicker response times than the detailed get-all endpoint.

Authentication

To execute this request, you need a platform token or OAuth access token with storage:filter-segments:read scope. To learn how to obtain and use it, see Tokens and authentication.

Parameters

ParameterTypeDescriptionInRequired
add-fieldsstring[]

Add additional fields.

The element can hold these values
  • VARIABLES
  • EXTERNALID
  • RESOURCECONTEXT
  • OWNER
queryOptional

Response

Response codes

CodeTypeDescription
200LeanFilterSegments

Filter-segments successfully retrieved.

400ErrorEnvelope

bad request

401ErrorEnvelope

unauthorized

403ErrorEnvelope

missing permissions

Response body objects

The LeanFilterSegments object

ElementTypeDescription
filterSegmentsLeanFilterSegment[]

List of filter-segments.

The LeanFilterSegment object

List of filter-segments.

ElementTypeDescription
allowedOperationsstring[]

Defines the allowed operations of the current user.

The element can hold these values
  • READ
  • WRITE
  • DELETE
  • SHARE
externalIdstring

Optional unique identifier of the filter-segment. Used for Dynatrace Configuration as Code

isPublicboolean

Indicates if the filter-segment is publicly accessible within the tenant.

isReadyMadeboolean

Indicates if the segment is ready-made.

namestring

Name of the filter-segment.

ownerstring

Defines the owner of the filter-segment.

uidstring

Unique identifier of the filter-segment.

variablesFilterSegmentVariables

Variables of the filter-segment.

The FilterSegmentVariables object

Variables of the filter-segment.

ElementTypeDescription
typestring

Type of the variable.

valuestring

Value of the variable.

The ErrorEnvelope object

ElementTypeDescription
errorExceptionalReturn-

The ExceptionalReturn object

ElementTypeDescription
codeinteger-
errorDetails(CustomValidationErrorInfo | InvalidAuditEventsErrorInfo | MediaTypeErrorInfo | ParameterErrorInfo | ProxyErrorInfo | QueryFrontendRawErrorInfo | RequestBodyErrorInfo)[]-
messagestring-

The CustomValidationErrorInfo object

The ErrorInfo object

ElementTypeDescription
messagestring-

The InvalidAuditEventsErrorInfo object

The MediaTypeErrorInfo object

The ParameterErrorInfo object

The ProxyErrorInfo object

The QueryFrontendRawErrorInfo object

The RequestBodyErrorInfo object

Response body JSON models

{
"filterSegments": [
{
"uid": "D82a1jdA23a",
"name": "dev_environment",
"variables": {
"type": "query",
"value": "fetch logs | limit 1"
},
"isPublic": false
},
{
"uid": "aa2E2xA01yA",
"name": "prod_environment",
"variables": {
"type": "query",
"value": "fetch logs | limit 1"
},
"isPublic": true
}
]
}
{
"error": {
"code": 400,
"message": "Missing request header",
"errorDetails": [
{
"type": "parameter",
"parameterDescriptor": "Dt-Tenant",
"message": "is required"
}
]
}
}
Related tags
Platform APIDynatrace Platform