V1::Filter

Represents a user-defined filter for determining which statuses should not be shown to the user. Contains a single keyword or phrase.

Example 

{
  "id": "8449",
  "phrase": "test",
  "context": [
    "home",
    "notifications",
    "public",
    "thread"
  ],
  "whole_word": false,
  "expires_at": "2019-11-26T09:08:06.254Z",
  "irreversible": true
}

Attributes

id

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

phrase

Description: The text to be filtered.
Type: String
Version history:
2.4.3 - added

context

Description: The contexts in which the filter should be applied.
Type: Array of String (Enumerable anyOf)
home = home timeline and lists
notifications = notifications timeline
public = public timelines
thread = expanded thread of a detailed status
account = when viewing a profile
Version history:
2.4.3 - added
3.1.0 - added account

expires_at

Description: When the filter should no longer be applied.
Type: nullable String (ISO 8601 Datetime), or null if the filter does not expire
Version history:
2.4.3 - added

irreversible

Description: Should matching entities in home and notifications be dropped by the server? See implementation guidelines for filters.
Type: Boolean
Version history:
2.4.3 - added

whole_word

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

See also

Implementation guidelines for filters
v1 filters API
app/serializers/rest/v1/filter_serializer.rb

Last updated November 20, 2022 · Improve this page