Skip to content

Filters

Filters allow for you to filter every item added to the collection/overlay/playlist from every Builder using the filters attribute.

Using Filters

Filters cannot do anything alone they require the use of at least one Builder to function.

You can have multiple filters in each set but an item must match at least one value from each filter to not be ignored. The values for each must match what Plex has including special characters in order to match.

filters:
  genre: Action
  country: Germany

Anything that doesn't have both the Genre Action and the Country Germany will be ignored.

Multiple Filter Sets can be given as a list. With multiple sets only one of the sets must pass for the item to not be ignored. 

filters:
  - genre: Action
    country: Germany
  - genre: Comedy
    country: France

Anything that doesn't have either both the Genre Action and the Country Germany or the Genre Comedy and the Country France will be ignored.

All filter options are listed below.

To display items filtered out add show_filtered: true to the definition. To display items that make it through the filters add show_unfiltered: true to the definition.

You can use the plex_all: true Builder to filter from your entire library.

Warning

Filters can be very slow, particularly on larger libraries. Try to build or narrow your items using a Smart Label Collection, Plex Search or another Builder if possible.

Filter Options

Modifiers: No Modifier

Boolean Filter Attributes

Boolean Filters Description Allowed Media
has_collection Matches every item that has or does not have a collection Movies
Shows
Seasons,
Episodes
Artists
Albums
Tracks
has_dolby_vision(1) Matches every item that has or does not have a dolby vision Movies
Shows(2)
Seasons(3)
Episodes
has_edition Matches every item that has or does not have an edition Movies
has_overlay Matches every item that has or does not have an overlay Movies
Shows
Seasons,
Episodes
Artists
Albums
has_stinger Matches every item that has a media stinger (After/During Credits Scene) Movies
  1. Filters using the special episodes/tracks filter with the default percent.
  2. Filters using the special episodes/tracks filter with the default percent.
  3. Filters using the special episodes/tracks filter with the default percent.

Examples

collections:
 Movies with Mediastingers:
   plex_all: true
   filters:
     has_stinger: true

collections:
 Movies with Editions:
   plex_all: true
   filters:
     has_edition: true

Modifiers: No Modifier, .not, .before, .after, or .regex

Date filters can NOT take multiple values.

Date Filter Attributes

Date Filters Description Allowed Media
added Uses the date added attribute to match Movies
Shows
Seasons,
Episodes
Artists
Albums
Tracks
first_episode_aired(1) Uses the first episode aired date to match Shows
last_episode_aired_or_never(3) Similar to last_episode_aired but also includes those that haven't aired yet Shows
last_episode_aired(2) Uses the last episode aired date to match Shows
last_played Uses the date last played attribute to match Movies
Shows
Seasons,
Episodes
Artists
Albums
Tracks
release Uses the release date attribute (originally available) to match Movies
Shows
Episodes
Albums
  1. Also filters out missing movies/shows from being added to Radarr/Sonarr. These Values also cannot use the count modifiers.
  2. Also filters out missing movies/shows from being added to Radarr/Sonarr. These Values also cannot use the count modifiers.
  3. Also filters out missing movies/shows from being added to Radarr/Sonarr. These Values also cannot use the count modifiers.
Date Filter Modifiers
Date Modifier Description Format
No Modifier Matches every item where the date attribute is in the last X days Format: number of days
e.g. 30
.after Matches every item where the date attribute is after the given date Format: MM/DD/YYYY or today for the current day
e.g. 01/01/2000
.before Matches every item where the date attribute is before the given date Format: MM/DD/YYYY or today for the current day
e.g. 01/01/2000
.not Matches every item where the date attribute is not in the last X days Format: number of days
e.g. 30
.regex Matches every item where the attribute matches the regex given N/A

Examples

collections:
 Summer 2020 Movies:
   plex_all: true
   filters:
     release.after: 5/1/2020
     release.before: 8/31/2020

collections:
 Movies Released in the Last 180 Days:
   plex_all: true
   filters:
     release: 180

Modifiers: No Modifier, .not, .gt, .gte, .lt, or .lte

Number filters can NOT take multiple values.

Number Filter Attributes

Number Filters Description Allowed Media
aspect(15) Uses the aspect attribute to match
minimum: 0.0		 Movies
Shows(16)
Seasons(17)
Episodes
audience_rating Uses the audience rating attribute to match
0.0 - 10.0		 Movies
Shows
Episodes
channels(6) Uses the audio channels attribute to match
minimum: 0		 Movies
Shows(7)
Seasons(8)
Episodes
critic_rating Uses the critic rating attribute to match
0.0 - 10.0		 Movies
Shows
Episodes
Albums
duration Uses the duration attribute to match using minutes
minimum: 0		 Movies
Shows
Episodes
Tracks
height(9) Uses the height attribute to match
minimum: 0		 Movies
Shows(10)
Seasons(11)
Episodes
plays Uses the plays attribute to match
minimum: 1		 Movies
Shows
Seasons,
Episodes
Artists
Albums
Tracks
stinger_rating(23) Uses the Mediastinger rating to match.
The media stinger rating is if the after/during credits scene is worth staying for.
minimum: 0		 Movies
tmdb_vote_average(5) Uses the tmdb vote average rating to match
minimum: 0.0		 Movies
Shows
tmdb_vote_count(4) Uses the tmdb vote count to match
minimum: 1		 Movies
Shows
tmdb_year(2)(3) Uses the year on TMDb to match
minimum: 1		 Movies
Shows
user_rating Uses the user rating attribute to match
0.0 - 10.0		 Movies
Shows
Seasons,
Episodes
Artists
Albums
Tracks
versions(18) Uses the number of versions found to match
minimum: 0		 Movies
Shows(19)
Seasons(20),
Episodes
Artists(21)
Albums(22)
Tracks
width(12) Uses the width attribute to match
minimum: 0		 Movies
Shows(13)
Seasons(14)
Episodes
year(1) Uses the year attribute to match
minimum: 1		 Movies
Shows
Seasons,
Episodes
Albums
Tracks
  1. You can use current_year to have Kometa use the current year's value. This can be combined with a -# at the end to subtract that number of years. i.e. current_year-2
  2. Also filters out missing movies/shows from being added to Radarr/Sonarr. These Values also cannot use the count modifiers.
  3. You can use current_year to have Kometa use the current year's value. This can be combined with a -# at the end to subtract that number of years. i.e. current_year-2
  4. Also filters out missing movies/shows from being added to Radarr/Sonarr. These Values also cannot use the count modifiers.
  5. Also filters out missing movies/shows from being added to Radarr/Sonarr. These Values also cannot use the count modifiers.
  6. Filters using the special episodes/tracks filter with the default percent.
  7. Filters using the special episodes/tracks filter with the default percent.
  8. Filters using the special episodes/tracks filter with the default percent.
  9. Filters using the special episodes/tracks filter with the default percent.
  10. Filters using the special episodes/tracks filter with the default percent.
  11. Filters using the special episodes/tracks filter with the default percent.
  12. Filters using the special episodes/tracks filter with the default percent.
  13. Filters using the special episodes/tracks filter with the default percent.
  14. Filters using the special episodes/tracks filter with the default percent.
  15. Filters using the special episodes/tracks filter with the default percent.
  16. Filters using the special episodes/tracks filter with the default percent.
  17. Filters using the special episodes/tracks filter with the default percent.
  18. Filters using the special episodes/tracks filter with the default percent.
  19. Filters using the special episodes/tracks filter with the default percent.
  20. Filters using the special episodes/tracks filter with the default percent.
  21. Filters using the special episodes/tracks filter with the default percent.
  22. Filters using the special episodes/tracks filter with the default percent.
  23. The actual numbers are pulled from the Mediastingers Repo.
Number Filter Modifiers
Number Modifier Description Format
No Modifier Matches every item where the number attribute is equal to the given number Format: number
e.g. 30, 1995, or 7.5
.gt Matches every item where the number attribute is greater than the given number Format: number
e.g. 30, 1995, or 7.5
.gte Matches every item where the number attribute is greater than or equal to the given number Format: number
e.g. 30, 1995, or 7.5
.lt Matches every item where the number attribute is less than the given number Format: number
e.g. 30, 1995, or 7.5
.lte Matches every item where the number attribute is less than or equal to the given number Format: number
e.g. 30, 1995, or 7.5
.not Matches every item where the number attribute is not equal to the given number Format: number
e.g. 30, 1995, or 7.5

Examples

collections:
 9.0 Movies:
   plex_all: true
   filters:
     user_rating.gte: 9

collections:
 Good Adam Sandler Romantic Comedies:
   plex_search:
     all:
       genre: Romance
       actor: Adam Sandler
   filters:
     genre: Comedy
     user_rating.gte: 7

Modifiers: No Modifier, .not, .is, .isnot, .begins, .ends, or .regex

String filters can take multiple values only as a list.

String Filter Attributes

String Filter Description Allowed Media
audio_codec(20) Uses the audio codec tags to match Movies
Shows(21)
Seasons(22)
Episodes
audio_profile(23) Uses the audio profile tags to match Movies
Shows(24)
Seasons(25)
Episodes
audio_track_title(9) Uses the audio track titles to match Movies
Shows(10)
Seasons(11)
Episodes
Artists(12)
Albums(13)
Tracks
edition Uses the edition attribute to match Movies
filepath(4) Uses the item's filepath to match Movies
Shows(5)
Seasons(6)
Episodes
Artists(7)
Albums(8)
Tracks
folder Uses the item's folder to match Shows
Artists
record_label Uses the record label attribute to match Albums
studio Uses the studio attribute to match Movies
Shows
summary Uses the summary attribute to match Movies
Shows
Seasons
Episodes
Artists
Albums
Tracks
title Uses the title attribute to match Movies
Shows
Seasons
Episodes
Artists
Albums
Tracks
tmdb_title(1) Uses the title from TMDb to match Movies
Shows
tvdb_status(3) Uses the status from TVDb to match Shows
tvdb_title(2) Uses the title from TVDb to match Shows
video_codec(14) Uses the video codec tags to match Movies
Shows(15)
Seasons(16)
Episodes
video_profile(17) Uses the video profile tags to match Movies
Shows(18)
Seasons(19)
Episodes
  1. Also filters out missing movies/shows from being added to Radarr/Sonarr. These Values also cannot use the count modifiers.
  2. Also filters out missing movies/shows from being added to Radarr/Sonarr. These Values also cannot use the count modifiers.
  3. Also filters out missing movies/shows from being added to Radarr/Sonarr. These Values also cannot use the count modifiers.
  4. Filters using the special episodes/tracks filter with the default percent.
  5. Filters using the special episodes/tracks filter with the default percent.
  6. Filters using the special episodes/tracks filter with the default percent.
  7. Filters using the special episodes/tracks filter with the default percent.
  8. Filters using the special episodes/tracks filter with the default percent.
  9. Filters using the special episodes/tracks filter with the default percent.
  10. Filters using the special episodes/tracks filter with the default percent.
  11. Filters using the special episodes/tracks filter with the default percent.
  12. Filters using the special episodes/tracks filter with the default percent.
  13. Filters using the special episodes/tracks filter with the default percent.
  14. Filters using the special episodes/tracks filter with the default percent.
  15. Filters using the special episodes/tracks filter with the default percent.
  16. Filters using the special episodes/tracks filter with the default percent.
  17. Filters using the special episodes/tracks filter with the default percent.
  18. Filters using the special episodes/tracks filter with the default percent.
  19. Filters using the special episodes/tracks filter with the default percent.
  20. Filters using the special episodes/tracks filter with the default percent.
  21. Filters using the special episodes/tracks filter with the default percent.
  22. Filters using the special episodes/tracks filter with the default percent.
  23. Filters using the special episodes/tracks filter with the default percent.
  24. Filters using the special episodes/tracks filter with the default percent.
  25. Filters using the special episodes/tracks filter with the default percent.
String Filter Modifiers
String Modifier Description
No Modifier Matches every item where the attribute contains the given string
.begins Matches every item where the attribute begins with the given string
.ends Matches every item where the attribute ends with the given string
.is Matches every item where the attribute exactly matches the given string
.isnot Matches every item where the attribute does not exactly match the given string
.not Matches every item where the attribute does not contain the given string
.regex Matches every item where the attribute matches the regex given

Examples

collections:
  Movies with Commentary:
    plex_all: true
    filters:
      audio_track_title: Commentary

collections:
  Movies with Audio Codecs containing DTS:
    plex_all: true
    filters:
      audio_codec: DTS

Modifiers: No Modifier, .not, .regex, .count_lt, .count_lte, .count_gt, or .count_gte

Tag filters can take multiple values as a list or a comma-separated string.

Tag Filter Attributes

Tag Filters Description Allowed Media
actor Uses the actor tags to match Movies
Shows
Episodes
audio_language(5) Uses the audio language tags to match Movies
Shows(6)
Seasons(7)
Episodes
collection Uses the collection tags to match Movies
Shows
Seasons,
Episodes
Artists
Albums
Tracks
content_rating Uses the content rating tags to match Movies
Shows
Episodes
country Uses the country tags to match Movies
Artists
director Uses the director tags to match Movies
Episodes
genre Uses the genre tags to match Movies
Shows
Artists
Albums
imdb_keyword(15) Uses the keywords from IMDb to match See Special for more attributes Movies
Shows
label Uses the label tags to match Movies
Shows
Seasons,
Episodes
Artists
Albums
Tracks
network Uses the network tags to match Shows
origin_country(13) Uses TMDb origin country ISO 3166-1 alpha-2 codes to match
Example: origin_country: us		 Shows
producer Uses the actor tags to match Movies
Episodes
resolution(2) Uses the resolution tag to match Movies
Shows(3)
Seasons(4)
Episodes
subtitle_language(8) Uses the subtitle language tags to match Movies
Shows(9)
Seasons(10)
Episodes
tmdb_genre(11) Uses the genres from TMDb to match Movies
Shows
tmdb_keyword(12) Uses the keywords from TMDb to match Movies
Shows
tvdb_genre(14) Uses the genres from TVDb to match Shows
writer Uses the writer tags to match Movies
Episodes
year(1) Uses the year tag to match Movies
Shows
Seasons,
Episodes
Albums
Tracks
  1. You can use current_year to have Kometa use the current year's value. This can be combined with a -# at the end to subtract that number of years. i.e. current_year-2
  2. Filters using the special episodes/tracks filter with the default percent.
  3. Filters using the special episodes/tracks filter with the default percent.
  4. Filters using the special episodes/tracks filter with the default percent.
  5. Filters using the special episodes/tracks filter with the default percent.
  6. Filters using the special episodes/tracks filter with the default percent.
  7. Filters using the special episodes/tracks filter with the default percent.
  8. Filters using the special episodes/tracks filter with the default percent.
  9. Filters using the special episodes/tracks filter with the default percent.
  10. Filters using the special episodes/tracks filter with the default percent.
  11. Also filters out missing movies/shows from being added to Radarr/Sonarr. These Values also cannot use the count modifiers.
  12. Also filters out missing movies/shows from being added to Radarr/Sonarr. These Values also cannot use the count modifiers.
  13. Also filters out missing movies/shows from being added to Radarr/Sonarr. These Values also cannot use the count modifiers.
  14. Also filters out missing movies/shows from being added to Radarr/Sonarr. These Values also cannot use the count modifiers.
  15. Also filters out missing movies/shows from being added to Radarr/Sonarr. These Values also cannot use the count modifiers.
Tag Filter Modifiers
Tag Modifier Description
No Modifier Matches every item where the attribute matches the given string
.count_gt Matches every item where the attribute count is greater than the given number
.count_gte Matches every item where the attribute count is greater than or equal to the given number
.count_lt Matches every item where the attribute count is less than the given number
.count_lte Matches every item where the attribute count is less than the given number
.not Matches every item where the attribute does not match the given string
.regex Matches every item where one value of this attribute matches the regex.

Examples

collections:
 Daniel Craig only James Bonds:
   imdb_list:
     list_id: ls006405458
   filters:
     actor: Daniel Craig

collections:
 French Romance:
   plex_search:
     all:
       genre: Romance
   filters:
     audio_language: Français

Special Filters each have their own set of rules for how they're used.

Attribute

Special Filters Description Allowed Media
albums Uses the item's albums attributes to match
Use the percentage attribute given a number between 0-100 to determine the percentage of an item's albums that must match the sub-filter.		 Artists
episodes Uses the item's episodes attributes to match
Use the percentage attribute given a number between 0-100 to determine the percentage of an item's episodes that must match the sub-filter.		 Shows
Seasons
history Uses the release date attribute (originally available) to match dates throughout history
day: Match the Day and Month to Today's Date
month: Match the Month to Today's Date
1-30: Match the Day and Month to Today's Date or 1-30 days before		 Movies
Shows
Episodes
Albums
imdb_keyword(7)(8) Uses the keywords from IMDb to match
keywords: list of keywords to match
minimum_votes: minimum number of votes keywords must have
minimum_relevant: minimum number of relevant votes keywords must have
minimum_percentage: minimum percentage of relevant votes keywords must have		 Movies
Shows
original_language(1)
original_language.not(2)		 Uses TMDb original language ISO 639-1 codes to match
Example: original_language: en, ko		 Movies
Shows
seasons Uses the item's seasons attributes to match
Use the percentage attribute given a number between 0-100 to determine the percentage of an item's seasons that must match the sub-filter.		 Shows
tmdb_status(3)
tmdb_status.not(4)		 Uses TMDb Status to match
Values: returning, planned, production, ended, canceled, pilot		 Shows
tmdb_type(5)
tmdb_type.not(6)		 Uses TMDb Type to match
Values: documentary, news, production, miniseries, reality, scripted, talk_show, video		 Shows
tracks Uses the item's tracks attributes to match
Use the percentage attribute given a number between 0-100 to determine the percentage of an item's tracks that must match the sub-filter.		 Artists
Albums
  1. Filters using the special episodes/tracks filter with the default percent.
  2. Filters using the special episodes/tracks filter with the default percent.
  3. Also filters out missing movies/shows from being added to Radarr/Sonarr. These Values also cannot use the count modifiers.
  4. Also filters out missing movies/shows from being added to Radarr/Sonarr. These Values also cannot use the count modifiers.
  5. Also filters out missing movies/shows from being added to Radarr/Sonarr. These Values also cannot use the count modifiers.
  6. Also filters out missing movies/shows from being added to Radarr/Sonarr. These Values also cannot use the count modifiers.
  7. Also filters out missing movies/shows from being added to Radarr/Sonarr. These Values also cannot use the count modifiers.
  8. Also is a Tag Filter and can use all of those modifiers.

Examples

collections:
 Shows That Finished Too Soon:
   plex_all: true
   filters:
     tmdb_status: canceled

collections:
 On This Day in Previous Years:
   plex_all: true
   filters:
     history: day