Try it free

Get the filter segment entity model

  • Latest Dynatrace
  • Reference
  • Published Oct 13, 2026

Get the filter segment entity model in Dynatrace with the Grail Filter Segments API to inspect the structure used for filter segments.

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

Overview

This operation returns the filter segment entity model. It does not take request parameters or a body, so you simply call it to retrieve the model definition.

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

The request doesn't provide any configurable parameters.

Response

Response codes

CodeTypeDescription
200FilterSegmentNamespaceDto

Filter-segments-entity-model successfully retrieved.

400ErrorEnvelope

bad request

401ErrorEnvelope

unauthorized

403ErrorEnvelope

missing permissions

Response body objects

The FilterSegmentNamespaceDto object

ElementTypeDescription
allowedFilterOperationsFilterSegmentPushDownFilterableDto[]

Allowed filter operations.

namestring

Name of the namespace.

typesFilterSegmentTypeDto[]

Types of the namespace.

The FilterSegmentPushDownFilterableDto object

Allowed filter operations.

ElementTypeDescription
filterNamestring-
supportedAttributesstring[]-

The FilterSegmentTypeDto object

Types of the namespace.

ElementTypeDescription
displayNamestring-
filtersEntitiesOnlyboolean-
fromTypesFilterSegmentRelationshipDto[]-
namestring-
propertiesFilterSegmentPropertyDto[]-
relatedTargetEntityOnlyboolean-
restrictedParentPropertiesstring[]-

The FilterSegmentRelationshipDto object

ElementTypeDescription
namestring-
targetstring-

The FilterSegmentPropertyDto object

ElementTypeDescription
namestring-
typestring-

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

{
"error": {
"code": 400,
"message": "Missing request header",
"errorDetails": [
{
"type": "parameter",
"parameterDescriptor": "Dt-Tenant",
"message": "is required"
}
]
}
}
Related tags
Platform APIDynatrace Platform