mirror of
https://github.com/Tautulli/Tautulli.git
synced 2025-07-07 05:31:15 -07:00
Update exporter API docs
This commit is contained in:
parent
be82c8f6d9
commit
44b4c10bf9
1 changed files with 93 additions and 0 deletions
93
API.md
93
API.md
|
@ -115,6 +115,21 @@ Returns:
|
||||||
Delete and recreate the cache directory.
|
Delete and recreate the cache directory.
|
||||||
|
|
||||||
|
|
||||||
|
### delete_export
|
||||||
|
Delete exports from Tautulli.
|
||||||
|
|
||||||
|
```
|
||||||
|
Required parameters:
|
||||||
|
export_id (int): The row id of the exported file to delete
|
||||||
|
|
||||||
|
Optional parameters:
|
||||||
|
delete_all (bool): 'true' to delete all exported files
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
None
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
### delete_history
|
### delete_history
|
||||||
Delete history rows from Tautulli.
|
Delete history rows from Tautulli.
|
||||||
|
|
||||||
|
@ -334,6 +349,21 @@ Download the Tautulli configuration file.
|
||||||
Download the Tautulli database file.
|
Download the Tautulli database file.
|
||||||
|
|
||||||
|
|
||||||
|
### download_export
|
||||||
|
Download an exported metadata file
|
||||||
|
|
||||||
|
```
|
||||||
|
Required parameters:
|
||||||
|
export_id (int): The row id of the exported file to download
|
||||||
|
|
||||||
|
Optional parameters:
|
||||||
|
None
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
download
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
### download_log
|
### download_log
|
||||||
Download the Tautulli log file.
|
Download the Tautulli log file.
|
||||||
|
|
||||||
|
@ -377,6 +407,30 @@ Returns:
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
||||||
|
### export_metadata
|
||||||
|
Export library or media metadata to a file
|
||||||
|
|
||||||
|
```
|
||||||
|
Required parameters:
|
||||||
|
section_id (int): The section id of the library to export, OR
|
||||||
|
rating_key (int): The rating key of the media item to export
|
||||||
|
|
||||||
|
Optional parameters:
|
||||||
|
file_format (str): 'json' (default) or 'csv'
|
||||||
|
metadata_level (int): The level of metadata to export (default 1)
|
||||||
|
media_info_level (int): The level of media info to export (default 1)
|
||||||
|
include_images (bool): True or False to export artwork and posters images
|
||||||
|
custom_fields (str): Comma separated list of custom fields to export
|
||||||
|
in addition to the export level selected
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
json:
|
||||||
|
{"result": "success",
|
||||||
|
"message": "Metadata export has started."
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
### get_activity
|
### get_activity
|
||||||
Get the current activity on the PMS.
|
Get the current activity on the PMS.
|
||||||
|
|
||||||
|
@ -972,6 +1026,45 @@ Returns:
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
||||||
|
### get_library_export
|
||||||
|
Get the data on the Tautulli export tables.
|
||||||
|
|
||||||
|
```
|
||||||
|
Required parameters:
|
||||||
|
section_id (str): The id of the Plex library section, OR
|
||||||
|
rating_key (str): The rating key of the exported item
|
||||||
|
|
||||||
|
Optional parameters:
|
||||||
|
order_column (str): "added_at", "sort_title", "container", "bitrate", "video_codec",
|
||||||
|
"video_resolution", "video_framerate", "audio_codec", "audio_channels",
|
||||||
|
"file_size", "last_played", "play_count"
|
||||||
|
order_dir (str): "desc" or "asc"
|
||||||
|
start (int): Row to start from, 0
|
||||||
|
length (int): Number of items to return, 25
|
||||||
|
search (str): A string to search for, "Thrones"
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
json:
|
||||||
|
{"draw": 1,
|
||||||
|
"recordsTotal": 10,
|
||||||
|
"recordsFiltered": 3,
|
||||||
|
"data":
|
||||||
|
[{"row_id": 2,
|
||||||
|
"timestamp": 1596484600,
|
||||||
|
"section_id": 1,
|
||||||
|
"rating_key": 270716,
|
||||||
|
"media_type": "movie",
|
||||||
|
"media_type_title": "Movie",
|
||||||
|
"filename": "Movie - Frozen II [270716].20200803125640.json",
|
||||||
|
"complete": 1
|
||||||
|
},
|
||||||
|
{...},
|
||||||
|
{...}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
### get_library_media_info
|
### get_library_media_info
|
||||||
Get the data on the Tautulli media info tables.
|
Get the data on the Tautulli media info tables.
|
||||||
|
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue