Example

{
	"id": "1197",
	"keyword": "bad word",
	"whole_word": false
}

Attributes

id

Description: The ID of the FilterKeyword in the database.
Type: String (cast from an integer, but not guaranteed to be a number)
Version history:
4.0.0 - added

keyword

Description: The phrase to be matched against.
Type: String
Version history:
4.0.0 - added

whole_word

Description: Should the filter consider word boundaries? See implementation guidelines for filters.
Type: Boolean
Version history:
4.0.0 - added

See also

Implementation guidelines for filters
/api/v2/filters methods
app/serializers/rest/filter_keyword_serializer.rb