@dynatrace-sdk/client-filter-segment-management v1.3.0

@dynatrace-sdk/client-filter-segment-management

Filter-Segment Management for Grail.

Slice, dice and contextualize your data to make it easier to find, understand and work with.

Installation

npm install @dynatrace-sdk/client-filter-segment-management

Getting help

• Visit SDK for Typescript guide in the Dynatrace Developer
• Ask a question in the Dynatrace Community

License

This SDK is distributed under the Apache License, Version 2.0, see LICENSE for more information.

API reference

Full API reference for the latest version of the SDK is also available at the Dynatrace Developer.

filterSegmentsClient

import { filterSegmentsClient } from '@dynatrace-sdk/client-filter-segment-management';

createFilterSegment

Create a new filter-segment.

Create a new segment and define data.

Required scopes:

• storage:filter-segments:write

New Filter-Segment

Provide a name and an optional description for the filter-segment.

Variables

Create variables to apply in your filter-segment data filters

Includes (Segment data)

Include all data that should be accessible when applying the filter-segment

IsPublic (Visibility)

• false: The filter-segment is private and only visible to the owner
• true: The filter-segment is visible to everyone in the environment

Parameters

Returns

Throws

import { filterSegmentsClient } from "@dynatrace-sdk/client-filter-segment-management";

const data = await filterSegmentsClient.createFilterSegment(
  {
    body: {
      name: "dev_environment",
      description:
        "only includes data of the dev environment",
      variables: {
        type: "query",
        value: "fetch logs | limit 1",
      },
      isPublic: false,
      includes: [
        {
          filter: "here goes the filter",
          dataObject: "logs",
        },
        {
          filter: "here goes another filter",
          dataObject: "events",
        },
      ],
    },
  },
);

deleteFilterSegment

Delete a filter-segment.

Remove the filter-segment from the environment for all users.

Required scopes:

• storage:filter-segments:delete

Parameters

Returns

Throws

import { filterSegmentsClient } from "@dynatrace-sdk/client-filter-segment-management";

const data = await filterSegmentsClient.deleteFilterSegment(
  { filterSegmentUid: "D82a1jdA23a" },
);

getFilterSegment

Get filter-segment by UID.

Get filter-segment by its UID.

Required scopes:

• storage:filter-segments:read

Parameters

Returns

Throws

import { filterSegmentsClient } from "@dynatrace-sdk/client-filter-segment-management";

const data = await filterSegmentsClient.getFilterSegment({
  filterSegmentUid: "D82a1jdA23a",
});

getFilterSegments

Get all filter-segments.

Returns all filter-segments. If details like description are not needed then consider using the :lean endpoint.

Required scopes:

• storage:filter-segments:read

Parameters

Returns

Throws

import { filterSegmentsClient } from "@dynatrace-sdk/client-filter-segment-management";

const data = await filterSegmentsClient.getFilterSegments();

getLeanFilterSegments

Get all filter-segments in a minimal/lean form.

Returns all filter-segments in a minimal representational form. This endpoint saves resources and as a result quicker response times can be expected over the more detailed get-all endpoint.

Required scopes:

• storage:filter-segments:read

Parameters

Returns

Throws

import { filterSegmentsClient } from "@dynatrace-sdk/client-filter-segment-management";

const data =
  await filterSegmentsClient.getLeanFilterSegments();

partiallyUpdateFilterSegment

Partially update a filter-segment.

Update one or more fields of a filter-segment.

Required scopes:

• storage:filter-segments:write

Following fields can be updated:

• name
• description
• isPublic
• variables*
• includes*

* If given the value will be overridden.

Fields not given will be ignored.

Parameters

Returns

Throws

import { filterSegmentsClient } from "@dynatrace-sdk/client-filter-segment-management";

const data =
  await filterSegmentsClient.partiallyUpdateFilterSegment({
    filterSegmentUid: "D82a1jdA23a",
    optimisticLockingVersion: 1,
    body: {
      description:
        "only includes data of the development environment",
    },
  });

updateFilterSegment

Update a filter-segment. All fields will be overwritten (also undefined or null fields).

Update one or more fields of a filter-segment.

Required scopes:

• storage:filter-segments:write

Following fields can be updated:

• name
• description
• isPublic
• variables*
• includes*

* Values of the fields will be overridden or removed if not given.

Provide all other fields with unchanged values.

Parameters

Returns

Throws

import { filterSegmentsClient } from "@dynatrace-sdk/client-filter-segment-management";

const data = await filterSegmentsClient.updateFilterSegment(
  {
    filterSegmentUid: "D82a1jdA23a",
    optimisticLockingVersion: 1,
    body: {
      uid: "D82a1jdA23a",
      name: "dev_environment",
      description:
        "only includes data of the development environment",
      variables: {
        type: "query",
        value: "fetch logs | limit 1",
      },
      isPublic: false,
      owner: "john.doe",
      includes: [
        {
          filter: "here goes the filter",
          dataObject: "logs",
        },
        {
          filter: "here goes another filter",
          dataObject: "events",
        },
      ],
    },
  },
);

Types

CustomValidationErrorInfo

DetailedFilterSegment

ErrorEnvelope

ErrorInfo

ExceptionalReturn

FilterSegment

List of filter-segments.

FilterSegmentVariables

Variables of the filter-segment.

FilterSegments

Include

List of includes of the filter-segment.

InvalidAuditEventsErrorInfo

LeanFilterSegment

List of filter-segments.

LeanFilterSegments

MediaTypeErrorInfo

NewFilterSegment

NewInclude

List of includes of the filter-segment.

NewRelationship

Experimental The relationship of an include which has to be be specified when the data object is an entity view.

ParameterErrorInfo

PartialUpdateFilterSegment

ProxyErrorInfo

QueryFrontendRawErrorInfo

Relationship

Experimental The relationship of an include which has to be be specified when the data object is an entity view.

RequestBodyErrorInfo

UpdateFilterSegment

Enums

DetailedFilterSegmentAllowedOperationsItem

Defines the allowed operations of the current user.

Enum keys

Delete | Read | Write

FilterSegmentAllowedOperationsItem

Defines the allowed operations of the current user.

Enum keys

Delete | Read | Write

GetFilterSegmentQueryAddFieldsItem

Enum keys

Externalid | Includes | Resourcecontext | Variables

GetFilterSegmentsQueryAddFieldsItem

Enum keys

Externalid | Resourcecontext | Variables

GetLeanFilterSegmentsQueryAddFieldsItem

Enum keys

Externalid | Owner | Resourcecontext | Variables

LeanFilterSegmentAllowedOperationsItem

Defines the allowed operations of the current user.

Enum keys

Delete | Read | Write