Create filter template attribute

post

https://navigator-api.tweakwise.com/filtertemplate/{filterTemplateId}/attribute

Path Params

filterTemplateId

int64

required

Id of the filter template to add attribute to

Body Params

Filter template attribute api model that will be added

FilterTemplateId

int64

Id of the filter template the attribute belongs to

AttributeId

int64

Id of the attribute

Name

string

The text that is shown above the filter

Collapsible

boolean

Is the attribute collapsible

Collapsed

boolean

Is the attribute collapsed by default

NumberOfValues

int32

Number of values to show

ShowMoreText

string

Text for show more

ShowLessText

string

Text for show less

IsMultipleChoice

boolean

Is multiple choice, in case of 'DisplayFilter' being 'checkbox' or 'color'

Logic

string

enum

Optional logic in case of 'DisplayFilter' being 'checkbox' or 'color'.

Allowed:

DisplayFilter

string

enum

Display type of the filter.

Allowed:

NumberOfColumns

int32

The number of columns

ShowNumberOfProducts

boolean

Show the number of products that remains after the value has been selected

ShowIcon

boolean

Enclose a tag that can be replaced by an image in the front-end application

Sequence

int32

Sequence of the attribute, if left empty it will be automatically assigned

SortingOfValues

string

enum

The order in which the values of this filter are sorted. By using manual sorting, it is even possible to determine the order

Allowed:

ManualSortingValues

array of strings

Ordered list of values when 'SortingOfValues' is set to 'manual'

ManualSortingValues

ManualBackupSorting

string

enum

Backup sorting method of remaining values when 'SortingOfValues' is set to 'manual'

Allowed:

AlternativeSorting

string

enum

Sorting of values when the filter is expanded

Allowed:

ManualAlternativeSortingValues

array of strings

Ordered list of values when 'AlternativeSorting' is set to 'manual'

ManualAlternativeSortingValues

ManualBackupAlternativeSorting

string

enum

Backup sorting method of remaining values when 'AlternativeSorting' is set to 'manual'

Allowed:

ShowExplanation

boolean

Show explanation/help text for the filter.

Explanation

string

The explanation text to show

ShowFilter

boolean

Toggle show filter

ShowFilterPercentageThreshold

int32

If supplied, show filter only when at least the given percentage is achieved for the property 'ae-price'. Between 5 and 100 in increments of 5%

Prefix

string

Prefix

Suffix

string

Suffix

MinDepth

int32

Min depth for category or tree (Attribute source type)

MaxDepth

int32

Max depth for category or tree (Attribute source type)

ShowSelectedFirst

boolean

When a value has been selected, this appears at the top of the list, irrespective of the selected sorting

CssClass

string

Custom css class

HideFilterOnlyOneOption

boolean

Hide filter when there is only one option available.

IsClickPoint

boolean

Is Clickpoint toggle

ClickpointList

array of doubles

List of clickpoints for when DisplayFilter is set to 'ClickpointBucketSlider' and IsClickPoint is true.

ClickpointList

IsBucket

boolean

Is bucket toggle

BucketAmount

int32

Amount of buckets for when DisplayFilter is set to 'ClickpointBucketSlider' and IsBucket is true.

BucketStepSize

int32

Minimal bucket step size for when DisplayFilter is set to 'ClickpointBucketSlider' and IsBucket is true.

SortAutomaticFilterTemplate

boolean

Automatically determine where the filter is placed on the filter template based on usage.

SortAutomaticFilterValues

boolean

Automatically sort the filter values based on usage. If there is not enough data, the ‘sorting the values’ selected below is used.

IsSearchable

boolean

Show the search in attributes list

SearchPlaceholder

string

The text that is shown in the search field

SearchNoResultsText

string

The text that is shown when there are no results

NameTranslations

array of objects

Translations for the name

NameTranslations

ShowMoreTextTranslations

array of objects

Translations for the show more text

ShowMoreTextTranslations

ShowLessTextTranslations

array of objects

Translations for the show less text

ShowLessTextTranslations

ExplanationTranslations

array of objects

Translations for the explenation text

ExplanationTranslations

SearchPlaceholderTranslations

array of objects

Translations for the placeholder text

SearchPlaceholderTranslations

SearchNoResultsTextTranslations

array of objects

Translations for the no results text

SearchNoResultsTextTranslations

PrefixTranslations

array of objects

Translations for the prefix text

PrefixTranslations

SuffixTranslations

array of objects

Translations for the suffix text

SuffixTranslations

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

200The id of the added attribute

400BadRequest