Get the filter segment entity model in Dynatrace with the Grail Filter Segments API to inspect the structure used for filter segments.
| GET | SaaS | https://{your-environment-id}.apps.dynatrace.com/v1/filter-segments-entity-model |
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.
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.
The request doesn't provide any configurable parameters.
| Code | Type | Description |
|---|---|---|
| 200 | Filter | Filter-segments-entity-model successfully retrieved. |
| 400 | Error | bad request |
| 401 | Error | unauthorized |
| 403 | Error | missing permissions |
FilterSegmentNamespaceDto object| Element | Type | Description |
|---|---|---|
| allowedFilterOperations | Filter | Allowed filter operations. |
| name | string | Name of the namespace. |
| types | Filter | Types of the namespace. |
FilterSegmentPushDownFilterableDto objectAllowed filter operations.
| Element | Type | Description |
|---|---|---|
| filterName | string | - |
| supportedAttributes | string[] | - |
FilterSegmentTypeDto objectTypes of the namespace.
| Element | Type | Description |
|---|---|---|
| displayName | string | - |
| filtersEntitiesOnly | boolean | - |
| fromTypes | Filter | - |
| name | string | - |
| properties | Filter | - |
| relatedTargetEntityOnly | boolean | - |
| restrictedParentProperties | string[] | - |
FilterSegmentRelationshipDto object| Element | Type | Description |
|---|---|---|
| name | string | - |
| target | string | - |
FilterSegmentPropertyDto object| Element | Type | Description |
|---|---|---|
| name | string | - |
| type | string | - |
ErrorEnvelope object| Element | Type | Description |
|---|---|---|
| error | Exceptional | - |
ExceptionalReturn object| Element | Type | Description |
|---|---|---|
| code | integer | - |
| errorDetails | (Custom | - |
| message | string | - |
CustomValidationErrorInfo objectErrorInfo object| Element | Type | Description |
|---|---|---|
| message | string | - |
InvalidAuditEventsErrorInfo objectMediaTypeErrorInfo objectParameterErrorInfo objectProxyErrorInfo objectQueryFrontendRawErrorInfo objectRequestBodyErrorInfo object{"error": {"code": 400,"message": "Missing request header","errorDetails": [{"type": "parameter","parameterDescriptor": "Dt-Tenant","message": "is required"}]}}