FilterResult

Represents a filter whose keywords matched a given status.

Example

{
  "filter": {
    "id": "3",
    "title": "Hide completely",
    "context": [
      "home"
    ],
    "expires_at": "2022-09-20T17:27:39.296Z",
    "filter_action": "hide"
  },
  "keyword_matches": [
    "bad word"
  ],
  "status_matches": [
    "109031743575371913"
  ]
}

Attributes

`filter`

Description: The filter that was matched.
Type: Filter
Version history:
4.0.0 - added

`keyword_matches`

Description: The keyword within the filter that was matched.
Type: nullable Array of String, or null
Version history:
4.0.0 - added

`status_matches`

Description: The status ID within the filter that was matched.
Type: nullable Array of String, or null
Version history:
4.0.0 - added

See also

Implementation guidelines for filters

/api/v2/filters methods

app/serializers/rest/filter_result_serializer.rb

Last updated December 8, 2023 · Improve this page