Try it free

Grail - Filter Segments API

  • Latest Dynatrace
  • Reference
  • Published Oct 13, 2026

Define, create, update, and delete Grail Filter Segments in Dynatrace to constrain query scope with custom data filters and lean entity models.

Building a Dynatrace app?

Use the @dynatrace-sdk/client-filter-segment-management SDK client instead of calling this API directly — it handles authentication, typing, and the environment URL for you. This REST reference is for external and automation use.

Overview

Dynatrace Grail - Filter Segments lets you define and manage reusable filter segments that constrain query scope with custom data filters. Use it to create, inspect, update, and delete segments, or to retrieve them in full or lean form when you need a lighter response. Typical usage includes organizing common filtering logic for Grail queries, keeping access and analysis scopes consistent, and adjusting segment definitions as data or requirements change.

Authentication

Platform API endpoints use Platform token and OAuth client authentication. Attach a platform token or OAuth access token to the Authorization HTTP header using the Bearer scheme.

--header 'Authorization: Bearer <platform-token-or-oauth-access-token>'

For details, see Tokens and authentication and Platform tokens.

Endpoints

  • List filter segments (GET /filter-segments)
  • Create a filter segment (POST /filter-segments)
  • Get the filter segment entity model (GET /filter-segments-entity-model)
  • Get a filter segment (GET /filter-segments/{filterSegmentUid})
  • Update a filter segment (PUT /filter-segments/{filterSegmentUid})
  • Delete a filter segment (DELETE /filter-segments/{filterSegmentUid})
  • Partially update a filter segment (PATCH /filter-segments/{filterSegmentUid})
  • List filter segments in lean form (GET /filter-segments:lean)
Related tags
Platform APIDynatrace Platform