Plex
/
Plex-Meta-Manager
mirror of https://github.com/meisnate12/Plex-Meta-Manager.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
Page: Filters
Acknowledgements
AniDB Attributes
AniDB Builders
AniList Builders
Arr Details
Configuration File
Docker Walkthrough
Filters
FlixPatrol Builders
Home
ICheckMovies Builders
IMDb Builders
Image Asset Directory
Image Overlay Detail
Installation
Kubernetes Walkthrough
Letterboxd Builders
Libraries Attributes
Local Walkthrough
MdbList Builders
Metadata Details
Metadata and Playlist Files
Movie Library Metadata
Music Library Metadata
MyAnimeList Attributes
MyAnimeList Builders
Notifiarr Attributes
OMDb Attributes
Operations Attributes
Playlist Files Attributes
Plex Attributes
Plex Builders
Radarr Attributes
Run Commands & Environmental Variables
Schedule Detail
Scheduling Guide
Seasons Attributes
Setting Details
Settings Attributes
Smart Builders
Sonarr Attributes
StevenLu Builders
TMDb Attributes
TMDb Builders
TV Show Library Metadata
TVDb Builders
Tautulli Attributes
Tautulli Builders
Templates
Trakt Attributes
Trakt Builders
Webhooks Attributes
unRAID Walkthrough
5 Filters
meisnate12 edited this page 2 years ago

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

You can have multiple filters but an item must match at least one value from each filter to be added to a collection/playlist. The values for each must match what Plex has including special characters in order to match.

All filter options are listed below. To display items filtered out add show_filtered: true to the collection.

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

Filters can be very slow. Try to build or narrow your items using Plex Search if possible.

String Filters

String filters can be used with either no modifier or with .not, .is, .isnot, .begins, .ends, or .regex.

String filters can take multiple values only as a list.

Modifier

String Modifier Description
No Modifier Matches every item where the attribute contains the given string
.not Matches every item where the attribute does not contain 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
.begins Matches every item where the attribute begins with the given string
.ends Matches every item where the attribute ends with the given string
.regex Matches every item where the attribute matches the regex given

Attribute

String Filter Description Movies Shows Seasons Episodes Artists Albums Track
title Uses the title attribute to match ✔️ ✔️ ✔️ ✔️ ✔️ ✔️ ✔️
summary Uses the summary attribute to match ✔️ ✔️ ✔️ ✔️ ✔️ ✔️ ✔️
studio Uses the studio attribute to match ✔️ ✔️ ❌ ❌ ❌ ❌ ❌
record_label Uses the record label attribute to match ❌ ❌ ❌ ❌ ❌ ✔️ ❌
filepath Uses the item's filepath to match ✔️ ✔️ ❌ ✔️ ✔️ ❌ ✔️
audio_track_title Uses the audio track titles to match ✔️ ❌ ❌ ✔️ ❌ ❌ ✔️

Tag Filters

Tag filters can be used with either no modifier or with .not.

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

The original_language and tmdb_genre filters will also filter out movies/shows from being added to Radarr/Sonarr.

Modifier

Tag Modifier Description
No Modifier Matches every item where the attribute matches the given string
.not Matches every item where the attribute does not match the given string

Attribute

Tag Filters Description Movies Shows Seasons Episodes Artists Albums Track
actor Uses the actor tags to match ✔️ ✔️ ❌ ✔️ ❌ ❌ ❌
collection Uses the collection tags to match ✔️ ✔️ ✔️ ✔️ ✔️ ✔️ ✔️
content_rating Uses the content rating tags to match ✔️ ✔️ ❌ ✔️ ❌ ❌ ❌
network Uses the network tags to match ❌ ✔️ ❌ ❌ ❌ ❌ ❌
country Uses the country tags to match ✔️ ❌ ❌ ❌ ✔️ ❌ ❌
director Uses the director tags to match ✔️ ❌ ❌ ✔️ ❌ ❌ ❌
genre Uses the genre tags to match ✔️ ✔️ ❌ ❌ ✔️ ✔️ ❌
tmdb_genre Uses the genre from TMDb to match ✔️ ✔️ ❌ ❌ ❌ ❌ ❌
label Uses the label tags to match ✔️ ✔️ ❌ ❌ ❌ ✔️ ❌
producer Uses the actor tags to match ✔️ ❌ ❌ ✔️ ❌ ❌ ❌
year Uses the year tag to match ✔️ ✔️ ✔️ ✔️ ❌ ✔️ ✔️
writer Uses the writer tags to match ✔️ ❌ ❌ ✔️ ❌ ❌ ❌
original_language Uses TMDb original language ISO 639-1 codes to match
Example: original_language: en, ko		 ✔️ ✔️ ❌ ❌ ❌ ❌ ❌
resolution Uses the resolution tag to match ✔️ ❌ ❌ ✔️ ❌ ❌ ❌
audio_language Uses the audio language tags to match ✔️ ❌ ❌ ✔️ ❌ ❌ ❌
subtitle_language Uses the subtitle language tags to match ✔️ ❌ ❌ ✔️ ❌ ❌ ❌

Boolean Filters

Boolean Filters have no modifiers.

Attribute

Boolean Filters Description Movies Shows Seasons Episodes Artists Albums Track
has_collection Matches every item that has or does not have a collection ✔️ ✔️ ✔️ ✔️ ✔️ ✔️ ✔️
has_overlay Matches every item that has or does not have an overlay ✔️ ✔️ ❌ ❌ ❌ ❌ ❌

Date Filters

Date filters can be used with either no modifier or with .not, .before, .after, or .regex.

Date filters can NOT take multiple values.

The first_episode_aired and last_episode_aired filters will also filter out movies/shows from being added to Radarr/Sonarr.

Modifier

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
.not Matches every item where the date attribute
is not in the last X days		 Format: number of days
e.g. 30
.before Matches every item where the date attribute
is before the given date		 Format: MM/DD/YYYY
e.g. 01/01/2000
.after Matches every item where the date attribute
is after the given date		 Format: MM/DD/YYYY
e.g. 01/01/2000
.regex Matches every item where the attribute matches the regex given N/A

Attribute

Date Filters Description Movies Shows Seasons Episodes Artists Albums Track
release Uses the release date attribute (originally available) to match ✔️ ✔️ ❌ ✔️ ❌ ✔️ ❌
added Uses the date added attribute to match ✔️ ✔️ ✔️ ✔️ ✔️ ✔️ ✔️
last_played Uses the date last played attribute to match ✔️ ✔️ ✔️ ✔️ ✔️ ✔️ ✔️
first_episode_aired Uses the first episode aired date to match ❌ ✔️ ❌ ❌ ❌ ❌ ❌
last_episode_aired Uses the last episode aired date to match ❌ ✔️ ❌ ❌ ❌ ❌ ❌

Number Filters

Number filters must use .gt, .gte, .lt, or .lte as a modifier.

Number filters can NOT take multiple values.

The tmdb_vote_count and tmdb_year filters will also filter out movies/shows from being added to Radarr/Sonarr.

Modifier

Number Modifier Description Format
.gt Matches every item where the number attribute is greater then the given number Format: number
e.g. 30, 1995, or 7.5
.gte Matches every item where the number attribute is greater then 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 then the given number Format: number
e.g. 30, 1995, or 7.5
.lte Matches every item where the number attribute is less then or equal to the given number Format: number
e.g. 30, 1995, or 7.5

Attribute

Number Filters Description Movies Shows Seasons Episodes Artists Albums Track
year Uses the year attribute to match
minimum: 1		 ✔️ ✔️ ✔️ ✔️ ❌ ✔️ ✔️
tmdb_year Uses the year on TMDb to match
minimum: 1		 ✔️ ✔️ ❌ ❌ ❌ ❌ ❌
critic_rating Uses the critic rating attribute to match
0.0 - 10.0		 ✔️ ✔️ ❌ ✔️ ❌ ✔️ ❌
audience_rating Uses the audience rating attribute to match
0.0 - 10.0		 ✔️ ✔️ ❌ ✔️ ❌ ❌ ❌
user_rating Uses the user rating attribute to match
0.0 - 10.0		 ✔️ ✔️ ✔️ ✔️ ✔️ ✔️ ✔️
tmdb_vote_count Uses the tmdb vote count to match
minimum: 1		 ✔️ ✔️ ❌ ❌ ❌ ❌ ❌
plays Uses the plays attribute to match
minimum: 1		 ✔️ ✔️ ✔️ ✔️ ✔️ ✔️ ✔️
duration Uses the duration attribute to match using minutes
minimum: 0.0		 ✔️ ✔️ ❌ ✔️ ❌ ❌ ✔️

Special Filters

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

Attribute

Special Filters Description Movies Shows Seasons Episodes Artists Albums Track
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 Today's Date		 ✔️ ✔️ ❌ ✔️ ❌ ✔️ ❌

Collection Filter Examples

A few examples are listed below:

collections:
  1080p Documentaries:
    genre: Documentary
    summary: A collection of 1080p Documentaries
    filters:
      resolution: 1080

collections:
  Daniel Craig only James Bonds:
    imdb_list: https://www.imdb.com/list/ls006405458/
    filters:
      actor: Daniel Craig

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

collections:
  Romantic Comedies:
    genre: Romance
    filters:
      genre: Comedy

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

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

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

collections:
  Movies with Commentary:
    plex: all
    filters:
      audio_track_title: Commentary
Table of Contents

Want to contribute to this Wiki?

Fork it and send a pull request.

Delete Page

Deleting the wiki page 'Filters' cannot be undone. Continue?

No
Yes