Add user login table to API

This commit is contained in:
JonnyWong16 2016-05-14 23:09:43 -07:00
commit 6f33d29a51
4 changed files with 95 additions and 16 deletions

49
API.md
View file

@ -1271,7 +1271,7 @@ Returns:
"sync_id": "11617019",
"title": "Deadpool",
"total_size": "0",
"user_id": "328871",
"user_id": "696969",
"username": "DrukenDwarfMan",
"video_quality": "60"
},
@ -1286,7 +1286,7 @@ Get the data on PlexPy users IP table.
```
Required parameters:
user_id (str): The id of the Plex user
user_id (str): The id of the Plex user
Optional parameters:
order_column (str): "last_seen", "ip_address", "platform", "player",
@ -1317,7 +1317,7 @@ Returns:
"rating_key": 153037,
"thumb": "/library/metadata/153036/thumb/1462175062",
"transcode_decision": "transcode",
"user_id": 328871,
"user_id": 133788,
"year": 2016
},
{...},
@ -1327,6 +1327,45 @@ Returns:
```
### get_user_logins
Get the data on PlexPy user login table.
```
Required parameters:
user_id (str): The id of the Plex user
Optional parameters:
order_column (str): "date", "time", "ip_address", "host", "os", "browser"
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, "xxx.xxx.xxx.xxx"
Returns:
json:
{"draw": 1,
"recordsTotal": 2344,
"recordsFiltered": 10,
"data":
[{"browser": "Safari 7.0.3",
"date": 1462591869,
"friendly_name": "Jon Snow",
"host": "http://plexpy.castleblack.com",
"ip_address": "xxx.xxx.xxx.xxx",
"os": "Mac OS X",
"time": 1462591869,
"user": "LordCommanderSnow",
"user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_9_3) AppleWebKit/537.75.14 (KHTML, like Gecko) Version/7.0.3 Safari/7046A194A",
"user_group": "guest",
"user_id": 133788
},
{...},
{...}
]
}
```
### get_user_names
Get a list of all user and user ids.
@ -1369,7 +1408,7 @@ Returns:
"is_home_user": "1",
"is_restricted": "0",
"thumb": "https://plex.tv/users/k10w42309cynaopq/avatar",
"user_id": "328871",
"user_id": "133788",
"username": "Jon Snow"
},
{...},
@ -1418,7 +1457,7 @@ Returns:
"rating_key": 153037,
"thumb": "/library/metadata/153036/thumb/1462175062",
"transcode_decision": "transcode",
"user_id": 328871,
"user_id": 133788,
"user_thumb": "https://plex.tv/users/568gwwoib5t98a3a/avatar",
"year": 2016
},