tauturri: Get Data Out of 'Tautulli' (Formerly 'PlexPy')

Description

'Tautulli' (<http://tautulli.com>) is a monitoring application for 'Plex' Media Servers (<https://www.plex.tv>) which collects a lot of data about media items and server usage such as play counts. This package interacts with the 'Tautulli' API of any specified server to get said data into R. The 'Tautulli' API documentation is available at <https://github.com/Tautulli/Tautulli/blob/master/API.md>.

Author(s)

Maintainer: Lukas Burk lukas@quantenbrot.de

See Also

Useful links:

• https://github.com/jemus42/tauturri

• Report bugs at https://github.com/jemus42/tauturri/issues

Pipe operator

Description

See magrittr::%>% for details.

Usage

lhs %>% rhs

Make an API GET-request

Description

Make an API GET-request

Usage

api_request(url = NULL, apikey = NULL, cmd = "get_servers_info", ...)

Arguments

Value

The API result, usually a list.

Examples

## Not run: 
api_request("http://example.com/plexpy", "asdf", "get_servers_info")

## End(Not run)

Arnold

Description

Arnold

Usage

arnold(url = NULL, apikey = NULL)

Arguments

Value

A character of length 1.

Source

https://github.com/Tautulli/Tautulli/blob/master/API.md#arnold

Examples

## Not run: 
arnold()

## End(Not run)

Get Current Server Activity

Description

Get Current Server Activity

Usage

get_activity(url = NULL, apikey = NULL)

Arguments

Value

A list with bandwidth + stream info and a session tbl.

Examples

## Not run: 
get_activity()

## End(Not run)

Get Playback History

Description

Get Playback History

Usage

get_history(url = NULL, apikey = NULL, grouping = 0, user = NULL,
  user_id = NULL, rating_key = NULL, parent_rating_key = NULL,
  grandparent_rating_key = NULL, start_date = NULL, section_id = NULL,
  media_type = NULL, transcode_decision = NULL, order_column = NULL,
  order_dir = "desc", start = 0, length = 25, search = NULL)

Arguments

Value

A list with totals and the history as tbl

Source

https://github.com/Tautulli/Tautulli/blob/master/API.md#get_history

Examples

## Not run: 
get_history(length = 10)

## End(Not run)

Get Home Stats

Description

The data displayed on the Tautulli home.

Usage

get_home_stats(url = NULL, apikey = NULL, grouping = 0, time_range = 30,
  stats_type = 0, stats_count = 5)

Arguments

Value

A list of length 10, with tbls for each category of stats.

Source

https://github.com/Tautulli/Tautulli/blob/master/API.md#get_home_stats

Examples

## Not run: 
get_home_stats()

## End(Not run)

Get All the Libraries' Data

Description

Get All the Libraries' Data

Usage

get_libraries(url = NULL, apikey = NULL)

Arguments

Value

A tbl with columns section_id and section_name

Examples

## Not run: 
get_libraries()

## End(Not run)

Get All the Libraries-Table

Description

Get All the Libraries-Table

Usage

get_libraries_table(url = NULL, apikey = NULL, order_column = NULL,
  order_dir = "desc", start = 0, length = 25, search = NULL)

Arguments

Value

A tbl with columns section_id and section_name

Examples

## Not run: 
get_libraries_table()

## End(Not run)

Get A Single Library Information

Description

Get A Single Library Information

Usage

get_library(url = NULL, apikey = NULL, section_id)

Arguments

Value

A tbl with columns section_id and section_name

Examples

## Not run: 
get_library(section_id = 1)

## End(Not run)

Get A Library's Media Info

Description

Get A Library's Media Info

Usage

get_library_media_info(url = NULL, apikey = NULL, section_id = NULL,
  rating_key = NULL, section_type = "movie", order_column = "added_at",
  order_dir = "desc", start = 0, length = 25, search = NULL)

Arguments

Value

A list with a totals list and an items tbl

Source

https://github.com/Tautulli/Tautulli/blob/master/API.md#get_library_media_info

Examples

## Not run: 
get_library_media_info(section_id = 2)

## End(Not run)

Get Library Sections and Names

Description

Get Library Sections and Names

Usage

get_library_names(url = NULL, apikey = NULL)

Arguments

Value

A tbl with columns section_id and section_name

Examples

## Not run: 
get_library_names()

## End(Not run)

Get Library User Stats

Description

Get Library User Stats

Usage

get_library_user_stats(url = NULL, apikey = NULL, section_id)

Arguments

Value

A tbl with 4 columns and one row per user.

Source

https://github.com/Tautulli/Tautulli/blob/master/API.md#get_library_user_stats

Examples

## Not run: 
get_library_user_stats(section_id = 1)

## End(Not run)

Get Library Watch Time Stats

Description

Get Library Watch Time Stats

Usage

get_library_watch_time_stats(url = NULL, apikey = NULL, section_id = NULL)

Arguments

Value

A tbl of length 3

Source

https://github.com/Tautulli/Tautulli/blob/master/API.md#get_library_watch_time_stats

https://github.com/Tautulli/Tautulli/blob/master/API.md#get_library_names

Examples

## Not run: 
get_library_watch_time_stats(section_id = 2)

## End(Not run)

Get Plays by Date

Description

Get Plays by Date

Usage

get_plays_by_date(url = NULL, apikey = NULL, time_range = 30,
  y_axis = "plays", user_id = NULL)

Arguments

Value

A tbl with columns date, Movies, TV, Music

Source

https://github.com/Tautulli/Tautulli/blob/master/API.md#get_plays_by_date

See Also

Other Playback History: get_plays_by_dayofweek, get_plays_by_hourofday, get_plays_by_source_resolution, get_plays_by_stream_resolution, get_plays_by_stream_type, get_plays_per_month

Examples

## Not run: 
get_plays_by_date(y_axis = "duration")

## End(Not run)

Get Plays by Day of Week

Description

Get Plays by Day of Week

Usage

get_plays_by_dayofweek(url = NULL, apikey = NULL, time_range = 30,
  y_axis = "plays", user_id = NULL)

Arguments

Value

A tbl with columns hour, Movies, TV, Music

Source

https://github.com/Tautulli/Tautulli/blob/master/API.md#get_plays_by_dayofweek

See Also

Other Playback History: get_plays_by_date, get_plays_by_hourofday, get_plays_by_source_resolution, get_plays_by_stream_resolution, get_plays_by_stream_type, get_plays_per_month

Examples

## Not run: 
get_plays_by_dayofweek()

## End(Not run)

Get Plays by Hour of Day

Description

Get Plays by Hour of Day

Usage

get_plays_by_hourofday(url = NULL, apikey = NULL, time_range = 30,
  y_axis = "plays", user_id = NULL)

Arguments

Value

A tbl with columns hour, Movies, TV, Music

Source

https://github.com/Tautulli/Tautulli/blob/master/API.md#get_plays_by_hourofday

See Also

Other Playback History: get_plays_by_date, get_plays_by_dayofweek, get_plays_by_source_resolution, get_plays_by_stream_resolution, get_plays_by_stream_type, get_plays_per_month

Examples

## Not run: 
get_plays_by_hourofday()

## End(Not run)

Get Plays by Source Resolution

Description

Get Plays by Source Resolution

Usage

get_plays_by_source_resolution(url = NULL, apikey = NULL, time_range = 30,
  y_axis = "plays", user_id = NULL)

Arguments

Value

A tbl with columns hour, Movies, TV, Music

Source

https://github.com/Tautulli/Tautulli/blob/master/API.md#get_plays_by_source_resolution

See Also

Other Playback History: get_plays_by_date, get_plays_by_dayofweek, get_plays_by_hourofday, get_plays_by_stream_resolution, get_plays_by_stream_type, get_plays_per_month

Examples

## Not run: 
get_plays_by_source_resolution()

## End(Not run)

Get Plays by Stream Resolution

Description

Get Plays by Stream Resolution

Usage

get_plays_by_stream_resolution(url = NULL, apikey = NULL, time_range = 30,
  y_axis = "plays", user_id = NULL)

Arguments

Value

A tbl with columns hour, Movies, TV, Music

Source

https://github.com/Tautulli/Tautulli/blob/master/API.md#get_plays_by_source_resolution

See Also

Other Playback History: get_plays_by_date, get_plays_by_dayofweek, get_plays_by_hourofday, get_plays_by_source_resolution, get_plays_by_stream_type, get_plays_per_month

Examples

## Not run: 
get_plays_by_stream_resolution()

## End(Not run)

Get Plays by Stream Type

Description

Get Plays by Stream Type

Usage

get_plays_by_stream_type(url = NULL, apikey = NULL, time_range = 30,
  y_axis = "plays", user_id = NULL)

Arguments

Value

A tbl with columns date, Movies, TV, Music

Source

https://github.com/Tautulli/Tautulli/blob/master/API.md#get_plays_by_stream_type

See Also

Other Playback History: get_plays_by_date, get_plays_by_dayofweek, get_plays_by_hourofday, get_plays_by_source_resolution, get_plays_by_stream_resolution, get_plays_per_month

Examples

## Not run: 
get_plays_by_stream_type()

## End(Not run)

Get Plays by Top 10 Platforms

Description

Get Plays by Top 10 Platforms

Usage

get_plays_by_top_10_platforms(url = NULL, apikey = NULL, time_range = 30,
  y_axis = "plays", user_id = NULL)

Arguments

Value

A tbl with columns hour, Movies, TV, Music

Source

https://github.com/Tautulli/Tautulli/blob/master/API.md#get_plays_by_top_10_platforms

Examples

## Not run: 
get_plays_by_top_10_platforms()

## End(Not run)

Get Plays by Top 10 Users

Description

Get Plays by Top 10 Users

Usage

get_plays_by_top_10_users(url = NULL, apikey = NULL, time_range = 30,
  y_axis = "plays", user_id = NULL)

Arguments

Value

A tbl with columns user, Movies, TV, Music

Source

https://github.com/Tautulli/Tautulli/blob/master/API.md#get_plays_by_top_10_users

Examples

## Not run: 
get_plays_by_top_10_users()

## End(Not run)

Get Plays by Month

Description

Get Plays by Month

Usage

get_plays_per_month(url = NULL, apikey = NULL, time_range = 30,
  y_axis = "plays", user_id = NULL)

Arguments

Value

A tbl with columns month, Movies, TV, Music

Source

https://github.com/Tautulli/Tautulli/blob/master/API.md#get_plays_by_month

See Also

Other Playback History: get_plays_by_date, get_plays_by_dayofweek, get_plays_by_hourofday, get_plays_by_source_resolution, get_plays_by_stream_resolution, get_plays_by_stream_type

Examples

## Not run: 
get_plays_per_month()

## End(Not run)

Check for PMS Updates

Description

Check for PMS Updates

Usage

get_pms_update(url = NULL, apikey = NULL)

Arguments

Value

A list containing update information

Examples

## Not run: 
get_pms_update()

## End(Not run)

Get Recently Added Media Items

Description

Get Recently Added Media Items

Usage

get_recently_added(url = NULL, apikey = NULL, count = 10,
  section_id = NULL, start = NULL)

Arguments

Value

A tbl with count rows and 18 columns.

Source

https://github.com/Tautulli/Tautulli/blob/master/API.md#get_recently_added

Examples

## Not run: 
get_recently_added(section_id = 1)

## End(Not run)

Get Server Friendly Name

Description

Get Server Friendly Name

Usage

get_server_friendly_name(url = NULL, apikey = NULL)

Arguments

Value

A tbl with 8 columns minimum with one row per server.

Source

https://github.com/Tautulli/Tautulli/blob/master/API.md#get_server_friendly_name

See Also

Other Server Information: get_server_identity, get_server_id, get_server_list, get_servers_info

Examples

## Not run: 
get_server_friendly_name()

## End(Not run)

Get Server ID

Description

Get Server ID

Usage

get_server_id(url = NULL, apikey = NULL, hostname, port = 32400,
  remote = 0, ssl = 0)

Arguments

Value

A tbl with 8 columns minimum with one row per server.

Source

https://github.com/Tautulli/Tautulli/blob/master/API.md#get_server_id

See Also

Other Server Information: get_server_friendly_name, get_server_identity, get_server_list, get_servers_info

Examples

## Not run: 
get_server_id()

## End(Not run)

Get Server Identity

Description

Get Server Identity

Usage

get_server_identity(url = NULL, apikey = NULL)

Arguments

Value

A tbl with 2 columns.

Source

https://github.com/Tautulli/Tautulli/blob/master/API.md#get_servers_identity

See Also

Other Server Information: get_server_friendly_name, get_server_id, get_server_list, get_servers_info

Examples

## Not run: 
get_server_identity()

## End(Not run)

Get Server List

Description

Get Server List

Usage

get_server_list(url = NULL, apikey = NULL)

Arguments

Value

A tbl with 8 columns minimum with one row per server.

Source

https://github.com/Tautulli/Tautulli/blob/master/API.md#get_server_list

See Also

Other Server Information: get_server_friendly_name, get_server_identity, get_server_id, get_servers_info

Examples

## Not run: 
get_server_list()

## End(Not run)

Get Server Information

Description

Get Server Information

Usage

get_servers_info(url = NULL, apikey = NULL)

Arguments

Value

A tbl with 5 columns minimum.

Source

https://github.com/Tautulli/Tautulli/blob/master/API.md#get_servers_info

See Also

Other Server Information: get_server_friendly_name, get_server_identity, get_server_id, get_server_list

Examples

## Not run: 
get_servers_info()

## End(Not run)

Get Stream Type by Top 10 Platforms

Description

Get Stream Type by Top 10 Platforms

Usage

get_stream_type_by_top_10_platforms(url = NULL, apikey = NULL,
  time_range = 30, y_axis = "plays", user_id = NULL)

Arguments

Value

A tbl with columns platform, Direct_Play, Direct_Stream, Transcode.

Source

https://github.com/Tautulli/Tautulli/blob/master/API.md#get_stream_type_by_top_10_platforms

Examples

## Not run: 
get_stream_type_by_top_10_platforms()

## End(Not run)

Get Stream Type by Top 10 Users

Description

Get Stream Type by Top 10 Users

Usage

get_stream_type_by_top_10_users(url = NULL, apikey = NULL,
  time_range = 30, y_axis = "plays", user_id = NULL)

Arguments

Value

A tbl with columns user, Direct_Play, Direct_Stream, Transcode.

Source

https://github.com/Tautulli/Tautulli/blob/master/API.md#get_stream_type_by_top_10_users

Examples

## Not run: 
get_stream_type_by_top_10_users()

## End(Not run)

Get User IPs

Description

Get User IPs

Usage

get_user_ips(url = NULL, apikey = NULL, user_id, order_column = NULL,
  order_dir = "desc", start = 0, length = 50, search = NULL)

Arguments

Value

A tbl

Source

https://github.com/Tautulli/Tautulli/blob/master/API.md#get_user_ips

Examples

## Not run: 
get_user_ips(user_id = 192023)

## End(Not run)

Get User Logins

Description

Get User Logins

Usage

get_user_logins(url = NULL, apikey = NULL, user_id, order_column = NULL,
  order_dir = "desc", start = 0, length = 50, search = NULL)

Arguments

Value

A tbl

Source

https://github.com/Tautulli/Tautulli/blob/master/API.md#get_user_logins

Examples

## Not run: 
get_user_logins(user_id = 192023)

## End(Not run)

Get User Names and IDs

Description

Get User Names and IDs

Usage

get_user_names(url = NULL, apikey = NULL, add_pseudonym = FALSE)

Arguments

Value

A tbl

Source

https://github.com/Tautulli/Tautulli/blob/master/API.md#get_user_names

Examples

## Not run: 
get_user_names()

## End(Not run)

Get a Single User's Player Stats

Description

Get a Single User's Player Stats

Usage

get_user_player_stats(url = NULL, apikey = NULL, user_id)

Arguments

Value

A tbl

Source

https://github.com/Tautulli/Tautulli/blob/master/API.md#get_user_player_stats

Examples

## Not run: 
get_user_player_stats(user_id = 1352909)

## End(Not run)

Get a Single User's Player Stats

Description

Get a Single User's Player Stats

Usage

get_user_watch_time_stats(url = NULL, apikey = NULL, user_id)

Arguments

Value

A tbl

Source

https://github.com/Tautulli/Tautulli/blob/master/API.md#get_user_watch_time_stats

Examples

## Not run: 
get_user_watch_time_stats(user_id = 1352909)

## End(Not run)

Get Users

Description

Get Users

Usage

get_users(url = NULL, apikey = NULL)

Arguments

Value

A tbl

Source

https://github.com/Tautulli/Tautulli/blob/master/API.md#get_users

Examples

## Not run: 
get_users()

## End(Not run)

Get a Users Table

Description

Get a Users Table

Usage

get_users_table(url = NULL, apikey = NULL, order_column = NULL,
  order_dir = "desc", start = 0, length = 50, search = NULL)

Arguments

Value

A tbl

Source

https://github.com/Tautulli/Tautulli/blob/master/API.md#get_users_table

Examples

## Not run: 
get_users_table()

## End(Not run)

Search for Media Items

Description

Search for Media Items

Usage

search_server(url = NULL, apikey = NULL, query, limit = 10)

Arguments

Value

A list with each type of media

Note

I would have named the function search, but you know, base::search.

Source

https://github.com/Tautulli/Tautulli/blob/master/API.md#search

Examples

## Not run: 
search_server(query = "game of Thrones", limit = 1)

## End(Not run)

Check for Tautulli Updates

Description

Check for Tautulli Updates

Usage

update_check(url = NULL, apikey = NULL)

Arguments

Value

Invisibly TRUE when an update is available, FALSE when no update is available.

Source

https://github.com/Tautulli/Tautulli/blob/beta/API.md#update_check

Examples

## Not run: 
update_check()

## End(Not run)

Apply Tautulli Updates

Description

Apply Tautulli Updates

Usage

update_tautulli(url = NULL, apikey = NULL)

Arguments

Value

Invisibly TRUE when the update is applied, FALSE when there is an issue.

Source

https://github.com/Tautulli/Tautulli/blob/beta/API.md#update

Examples

## Not run: 
update_tautulli()

## End(Not run)

Common English Words

Description

A subset of 283 of the 1000 most common English words. From the original list, only words longer than 5 and without apostrophes were selected.

Usage

words

Format

A character of length 283 containing words.

Note

I should have just used stringr::words

Source

https://gist.github.com/deekayen/4148741/01c6252ccc5b5fb307c1bb899c95989a8a284616/