Return All Completed and Submitted Sessions for a Given Serial Number Including Step Data
To return all completed and submitted sessions for a specific serial number that includes step data, run the following command:
For Use With Service Principals Method (Recommended)
curl -X 'POST' 'https://vuforia.portal.ptc.com/customer-events/<orgid>/report' \
-H 'accept: application/json' \
-H 'x-requested-with: fetch' \
-H 'Authorization: Bearer [access_token]' \
-H 'Content-Type: application/json' \
-d '{ "serialNumber": <serial#>, "granularity": "step" }'
For Use With x-api-key Method
 |
This method will be deprecated in a future release. We instead recommend creating and using service principals for authentication. For more information, see Create Service Principals for External API Access.
|
curl -X 'POST' 'https://vuforia.portal.ptc.com/customer-events/<orgid>/report' \
-H 'accept: application/json' \
-H 'x-requested-with: fetch' \
-H 'x-api-key: <x-api-key secret>' \
-H 'Content-Type: application/json' \
-d '{ "serialNumber": <serial#>, "granularity": "step" }'
By default, when retrieving execution data that includes more granular information like steps, all events that are generated for the steps that require feedback will also be returned. For example, if a user executes a procedure in Vuforia Vantage and selects a Fail state, and then changes it to Pass state, multiple events will be generated for the same step (similar to the below example). The events are ordered by (step) number and endTime. The latest event for the step can be found by using last event in the list for (step) number.
 |
We don't recommend using endTime to determine the latest event for a step. In the future, endTime will be shortened based on the Remove User Information and Dates from Viewer Insights setting.
|
Example Results
The results that are returned should look similar to the following example:
{
"items": [
{
"sessionId": "ec4dfff9-d280-42c2-bff4-03d154924de9",
"procedure": {
"id": "2f0560f0-d5e9-11eb-9796-856502905bf2",
"title": "****",
"versionId": "a63e70d0150f3b2ba1cf9e81",
"versionName": "8.0",
"startTime": "2024-01-12T03:35:19.425Z",
"latestEventTimestamp": "2024-01-12T03:39:19.894Z",
"endTime": "2024-01-12T03:39:19.894Z",
"status": "incomplete",
"progress": "completed",
"feedback": "incomplete",
"serialNumber": "1234",
"requiresSerialNumber": true,
"steps": [
{
"lastVisitTime": "2024-01-12T03:35:19.463Z",
"status": "omitted",
"description": "****",
"number": 1,
"title": "****",
"ackType": "Confirmation"
},
{
"lastVisitTime": "2024-01-12T03:35:25.739Z",
"status": "confirmed",
"description": "****",
"number": 2,
"title": "****",
"ackType": "Confirmation",
"endTime": "2024-01-12T03:35:27.482Z"
},
{
"lastVisitTime": "2024-01-12T03:35:42.861Z",
"status": "pass",
"description": "****",
"number": 3,
"title": "****",
"ackType": "PassFail",
"endTime": "2024-01-12T03:36:13.211Z"
}
]
},
"user": {
"id": "7d496296-6a29-4f88-b9ca-d1f07e1c7e93",
"first_name": "****",
"last_name": "****",
"email": "****",
"role": "****"
}
}
],
"granularity": "step",
"fullCount": "1"
}
|
|
The status property under steps displays the value that the frontline user returned for a step that required feedback. Possible values include the following:
• omitted—the frontline user did not provide the required feedback for the step.
• confirmed—the frontline user confirmed that a step was completed on a step that required confirmation feedback.
• pass—the frontline user selected Pass on a step that required pass/fail feedback.
• fail—the frontline user selected Fail on a step that required pass/fail feedback.
|