Returns information about all lab instance results that have recently started or ended
- 15 Aug 2024
- 3 Minutes to read
- Print
Returns information about all lab instance results that have recently started or ended
- Updated on 15 Aug 2024
- 3 Minutes to read
- Print
Article summary
Did you find this summary helpful?
Thank you for your feedback
Get
/LatestResults
The LatestResults command returns information about all lab instance results that have recently changed state.
Security
API Key
Header parameter nameapi_key
All methods require an API key, which must be obtained from Skillable. This key is used by Skillable to validate your account. The key can be passed as an HTTP request header with the header name "api_key".
Query parameters
minutes
integer (int64) Required
Lab instances that have changed state within this many minutes of the current time will be included. This value cannot exceed 10,080 (7 days)
Example60
Responses
200
OK Response.
Example response returning information about all lab instance results that have recently changed state
{
"Results": [
{
"LabInstanceId": 349744,
"LabProfileId": 5522,
"Start": 1325376800,
"End": 1325376900,
"LastActivity": 1325376899,
"UserId": "555",
"ClassId": null,
"CompletionStatus": 1,
"TotalRunTimeSeconds": 2548,
"TaskCompletePercent": 33,
"IsExam": false,
"ExamPassed": null,
"ExamScore": null,
"ExamMaxPossibleScore": null,
"ExamPassingScore": null,
"IpAddress": null,
"Country": null,
"Region": null,
"City": null,
"Latitude": null,
"Longitude": null,
"LabHostId": 49,
"DatacenterId": 3,
"DeliveryRegionId": 2
},
{
"LabInstanceId": 349745,
"LabProfileId": 5523,
"Start": 1325377000,
"End": 1325377100,
"LastActivity": 1325377099,
"UserId": "555",
"ClassId": null,
"CompletionStatus": 1,
"TotalRunTimeSeconds": 4168,
"TaskCompletePercent": 44,
"IsExam": false,
"ExamPassed": null,
"ExamScore": null,
"ExamMaxPossibleScore": null,
"ExamPassingScore": null,
"IpAddress": null,
"Country": null,
"Region": null,
"City": null,
"Latitude": null,
"Longitude": null,
"LabHostId": 125,
"DatacenterId": 4,
"DeliveryRegionId": 3
}
],
"Status": 1,
"Error": null
}object
Results
Array of object
Array of LabResult.
object
LabInstanceId
integer (int64)
The unique identifier of the lab instance.
LabProfileId
integer (int32)
The unique identifier of the lab profile the lab instance is based on.
Start
integer (int64)
When the lab was started (in Unix epoch time).
End
integer (int64) | null
When the lab ended (in Unix epoch time).
LastActivity
integer (int64) | null
The last time the student interacted with the lab (in Unix epoch time).
UserId
string | null
The unique identifier of the user, as represented in your system.
ClassId
string | null
The unique identifier of the class the lab is related to, as represented in your system.
CompletionStatus
integer (int32)
1 = Cancelled
2 = No Show
3 = Incomplete
4 = Complete
10 = Storage Provisioning Failed
20 = Lab Creation Failed
30 = Resume Failed
40 = Save Failed
50 = Submitted For Grading
60 = Grading In Progress
TotalRunTimeSeconds
integer (int32)
The total number of seconds the lab was running, whether or not the student was present.
TaskCompletePercent
integer (int32)
If the lab has integrated tasks, the percentage of tasks that the user has completed.
IsExam
boolean | null
Indicates whether the lab is scored.
ExamPassed
boolean | null
Indicates whether the user passed the lab. Will only be set if the lab has activities which have been scored.
ExamScore
integer (int32) | null
Indicates the lab score. Will only be set if the lab has activities which have been scored.
ExamMaxPossibleScore
integer (int32) | null
Indicates the maximum possible score of the lab. Will only be set if the lab has activities which have been scored.
ExamPassingScore
integer (int32) | null
Indicates the minimum score required to pass the lab. Will only be set if the lab has activities which have been scored.
IpAddress
string | null
The user's IP address. This is only included if the IP address was provided when the lab was launched.
Country
string | null
The user's country as determined by IP address geolocation. This is only included if the IP address was provided when the lab was launched.
Region
string | null
The user's state/region as determined by IP address geolocation. This is only included if the IP address was provided when the lab was launched.
City
string | null
The user's city as determined by IP address geolocation. This is only included if the IP address was provided when the lab was launched.
Latitude
number | null
The user's latitude as determined by IP address geolocation. This is only included if the IP address was provided when the lab was launched.
Longitude
number | null
The user's longitude as determined by IP address geolocation. This is only included if the IP address was provided when the lab was launched.
LabHostId
integer
The ID of the lab host server that the lab instance is housed on.
DatacenterId
integer
The ID of the datacenter that the lab instance is located in.
DeliveryRegionId
integer
When specified, Skillable will attempt to launch the lab in the specified delivery region if a suitable host in that region is available and all required storage is available in that region. Delivery regions can be found using the DeliveryRegions command or Catalog command. Using the ipAddress parameter will result in a more reliable geo-location of the lab for the end user.
Status
integer (int32)
Indicates the status of the API request.
0 = Error
1 = Success
Error
string | null
In the event of an error, this will contain a detailed error message.
Was this article helpful?