List session users
GET {{baseUrl}}/videosdk/sessions/:sessionId/users?type=live&page_size=30&next_page_token=Usse957pzxvmYwlmCZ50a6CNXFrhztxuj82
Use this API to return a list of users from live or past sessions. You can specify a monthly date range for this data using the
from
and
to
query parameters. The month should fall within the last six months.
-
If you do
not
provide the
typequery parameter, the API defaults to thelivevalue and the API will only return metrics for users in a live session, if a session is currently in progress. -
To view metrics on past session users, provide the
pastvalue for thetypequery parameter.
Rate Limit Label
:
Heavy
Prerequisites:
- A Video SDK account.
Request Params
| Key | Datatype | Required | Description |
| type | string | | The session types:
past— A past session.live— A live session.
This value defaults to live. |
| page_size | number | | The number of records returned within a single API call. |
| next_page_token | string | | The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes. |
HEADERS
| Key | Datatype | Required | Description |
| Accept | string | | |
RESPONSES
status: OK
{"page_size":50,"next_page_token":"suQA5LvDBnH5No5OYD7mqpJuFzJqUOHK8U2","users":[{"id":"32dsfsd4g5gd","name":"exampleuser","device":"Windows","ip_address":"127.0.0.1","location":"New York","network_type":"Wifi","microphone":"Plantronics BT600","speaker":"Plantronics BT600","camera":"FaceTime HD Camera","data_center":"SC","connection_type":"P2P","join_time":"2021-12-07T05:42:28Z","leave_time":"2021-12-07T05:42:28Z","user_key":"myUserKey"},{"id":"32dsfsd4g5gd","name":"exampleuser","device":"Windows","ip_address":"127.0.0.1","location":"New York","network_type":"Wifi","microphone":"Plantronics BT600","speaker":"Plantronics BT600","camera":"FaceTime HD Camera","data_center":"SC","connection_type":"P2P","join_time":"2021-12-07T05:42:28Z","leave_time":"2021-12-07T05:42:28Z","user_key":"myUserKey"}]}