GET POST
/v6/endpoint-data/user-sessions
Endpoint user session list
Returns a list of all endpoint user sessions. Sessions from the last round are provided unless an explicit start and end is provided with from, to or window optional parameters.
Optional (Querystring) Parameters
format=json|xmloptional, specifies the format of output requested. See Output Formats for more informationwindow=[0-9]+[smhdw]?specifies a window of time for the result set. See Time Ranges for more information.from=YYYY-mm-ddTHH:MM:SS&to=YYYY-mm-ddTHH:MM:SSspecifies an explicit start (and optionally, end) for your range of data. See Time Ranges for more information.page={pageNo}this parameter is going to be deprecated - please rely on the URL in thepages[next]element included in the response. See Pagination for more information.aid={aid}optional and requires the user to be assigned to the target account group, specifies the account group context of the request, obtained from the/account-groupsendpoint. Specifying this parameter without the user being assigned to the target account will result in an error response. See Account group context for more information
Optional Filtering
/endpoint-data endpoints support optional filtering. See Endpoint Data Filtering for more information.
Request
- no request body
Example
$ curl https://api.thousandeyes.com/v6/endpoint-data/user-sessions.json \
-u {email}:{authToken}
Response
Sends back an object. userSessions parameter returns an array of endpoint user sessions, either the latest sessions, or based on the time range specified. Each entry represents an endpoint user session.
| Field | Data Type | Units | Notes |
|---|---|---|---|
| agentId | string | n/a | endpoint agent ID |
| committed | dateTime | yyyy-MM-dd hh:mm:ss | the date/time when endpoint user session was committed to the controller; all dates are UTC |
| date | dateTime | yyyy-MM-dd hh:mm:ss | the date/time when endpoint user session took place; all dates are UTC |
| experienceScore | number | 0-1 | score rating a user’s experience when loading a particular page, from 0 (the worst) to 1 (the best). More details |
| numberOfPages | integer | n/a | number of web pages visited on target website |
| orgName | string | n/a | name of the AS organization sourceAddr belongs to |
| pageId | string | n/a | web page ID; page ID is unique only within an endpoint user session |
| permalink | string | n/a | hyperlink to endpoint user session details in ThousandEyes Application |
| port | integer | n/a | port used to visit target website |
| protocol | string | n/a | protocol used to visit target website |
| roundId | integer | n/a | endpoint user session round ID |
| sourceAddr | string | n/a | public IP address of the endpoint agent during the session |
| userSessionId | string | n/a | endpoint user session ID; each endpoint user session occurrence has a unique ID |
| visitedSite | string | n/a | domain used to visit target website |
Header
HTTP/1.1 200 OK
Server: nginx
Date: Mon, 22 Mar 2017 13:41:02 GMT
Content-Type: application/json
Transfer-Encoding: chunked
Connection: keep-alive
Cache-Control: no-store
X-Organization-Rate-Limit-Limit: 600
X-Organization-Rate-Limit-Remaining: 599
X-Organization-Rate-Limit-Reset: 1490622120
Strict-Transport-Security: max-age=31536000
X-Server-Name: 1-3
Body
{
"userSessions": [
{
"agentId": "3fde6422-f119-40e1-ae32-d08a1243c038",
"committed": "2017-03-22 11:58:44",
"date": "2017-03-22 11:58:42",
"numberOfPages": 1,
"orgName": "T-2 Access Network",
"pageId": "C31gBrYJ",
"permalink": "https://app.thousandeyes.com/view/endpoint-agent/?roundId=1490529480&scenarioId=sessionDetails&binSize=300000&__aid=7625",
"port": 80,
"protocol": "http",
"roundId": 1490529480,
"sourceAddr": "84.255.241.1",
"userSessionId": "07625:1490529480:aVDViw0i",
"visitedSite": "thousandeyes.com"
},
{
"agentId": "3fde6422-f119-40e1-ae32-d08a1243c038",
"committed": "2017-03-22 11:58:46",
"date": "2017-03-22 11:58:43",
"numberOfPages": 1,
"orgName": "T-2 Access Network",
"pageId": "iLUEN9t8"
"permalink": "https://app.thousandeyes.com/view/endpoint-agent/?roundId=1490529480&scenarioId=sessionDetails&binSize=300000&__aid=7625",
"port": 443,
"protocol": "https",
"roundId": 1490529480,
"sourceAddr": "84.255.241.1",
"userSessionId": "07625:1490529480:h3qJQTpl",
"visitedSite": "www.thousandeyes.com"
}
[...]
}
"pages": {
"current": 1
}
}
For error responses, see the response status codes documentation.