Skip to main content

Create a segment

info

A segment can be either build on a query based or be a fixed based selection

tip

A segment can be used in an endpoint to either include the segment or to exclude the segment from an endpoint

To create a segment press the Add segment button in the upper right corner.

An image from the static

Select a segment type based on what you would like it to look like in the final UI and confirm with the Add [type] button

info

A segment type is build on a card definition

An image from the static

Filtering

By using the filters in the left hand column you can easily filter the data that you would like to include in the endpoint. The result of the filtering is reflected in the middle column.

tip

If you would like to filter on other attributes that is not shown in the left column, just click on "Add more filter" to be able to serach and add more attributes.

An image from the static

Dynamic query filter

If you want your segment to dynamically include all cards that correspond to the applied filter then you want to create a dynamic query filter. This is easily achieved. Basically, once you are done defining what attribute values to filter on, you click Apply to add this filter to the segment.

An image from the static

The entries that currently corresponds to this filter appears in the right-hand side column. Here you can choose to exclude induvidual entries by pressing the exclude button on the card. The card will remain in the right-hand column and can be re-included by pressing the include button on the card.

An image from the static

Verify that the correct filter type is used by inspecting the badge placed next to the Selected text. If it says "Query" you are creating a dynamic query filter segment. When pressing the Save [type] button you will be prompted to save the segment you just created.

An image from the static

Give the segment a name, the identifier will be automatically filled in based on the name you choose. Optionally you can add a description and the segment is created by pressing Save.

An image from the static

You have now created a segment using a dynamic query filter, meaning that any new items matching the filter criteria will be automatically added to the segment.

Fixed query filter

Start by identifying the induvidual entries you want to include in the segment by using the filters to identify them. When found, press the include button on the card in the middle column. The included card is added to the right hand column.

An image from the static

Verify that the correct filter type is used by inspecting the badge placed next to the Selected text. If it says "Query" you are creating a dynamic query filter segment. When pressing the Save [type] button you will be prompted to save the segment you just created.

Give the segment a name, the identifier will be automatically filled in based on the name you choose. Optionally you can add a description and the segment is created by pressing Save.

An image from the static

You have now created a segment using a fixed query filter, meaning that no new items will be added automatically. The only times the result set of this segment will change is when the segment is edited (cards are added or removed) or when a card is removed from the system.

Video walkthrough