Get all sessions
GET
/api/users/[user_id]/sessions
Retrieves a paginated list of sessions for a specific user. Each entry includes details about the session, including its activity, location, IP address, and other relevant information. The endpoint allows you to specify optional search parameters to filter and refine the results.
Query Parameters
page
number
The page number to retrieve.
Default: 1
size
number
The number of items per page.
Default: 10
client_id
string
The client ID by which the user sessions should be filtered.
sort
string
Specifies the sort criteria in the 'sort_key:sort_order' format. The sort order value can be '1' for ascending and '-1' for descending. Acceptable sort key values are 'session_id', 'initiated_at', 'expires_at', and 'last_updated'.
Path Parameters
user_id
string
Required
The ID of the user whose sessions should be retrieved.
Authentication
X-API-KEY
header
Required
The API key is essential for accessing MonoCloud's APIs. You can find it in the Tenant Settings section of your MonoCloud dashboard. To authenticate your requests, include this key in the request header using the following format: X-API-Key: <Your_API_Key>.
Headers
accept
string
- application/json
- application/problem+json
Responses
200
Successfully retrieved user's sessions
400
Bad Request
422
Client Error
404
Not Found
401
Unauthorized
403
Forbidden
Request Example
Request
curl -X GET "https://<your-domain>/api/users/{user_id}/sessions?page=1&size=10&client_id=eCOGRJYpnNwwAAuCeReEW&sort=initiated_at:1" \
-H "X-API-KEY: <your-api-key>" \
-H "Accept: application/json"
Response Example
Response
200 OK
[
{
"last_updated": 1640975400,
"expires_at": 1640983490,
"last_metadata": {
"country": "United States of America",
"city": "Los Angeles",
"latitude": "34.043238",
"ip_address": "1.1.1.1",
"region": "North America",
"user_agent": "The User Agent",
"longitude": "-118.250918"
},
"session_key": "CF13F82261B1FCE312E5651500620295BEDBF32207446BA5C1D9B61129F05A22",
"session_id": "96484D319ACC21380CCE026E54807B4D",
"initiated_at": 1640975400,
"client_ids": [
"eCOGRJYpnNwwAAuCeReEW"
]
}
]