Make the API Call
PII and Proprietary Data in API Calls
Visibility of all PII and proprietary data can be controlled using the following Vuforia settings:
|
Setting
|
Information
|
||
|---|---|---|---|
|
When this setting is disabled, the following is true:
• Procedure information (procedure title, user comments) will be redacted
• Step information (step description, step title, user comments, and media feedback) will be redacted
• User information (first name, last name, email, and role) will be redacted
This setting is disabled by default.
When this setting is enabled, the above data will not be redacted.
|
|||
|
When this setting is enabled, the data returned will be affected.
This setting is disabled by default.
|
 |
In situations where these two settings conflict with one another, redaction or shortening of the information will prevail.
|
API Call
You can make API calls to the /customer-events/<orgid>/report API that will return session data for a specified organization. The results can then be filtered using query parameters. The following query parameters may be useful:
• feedback
• serialNumber
• failures
• progress
For more detailed information about the above parameters, see the Available Parameters.
 |
For best results, URL parameters should be encoded, as some characters will not work without encoding them. For example, if a serial number is 'serial$number#with|special&chars', then the encoded version that is safe and recommended to use as a URL parameter would be 'serial%24number%23with%7Cspecial%26chars'.
|
The following examples are available:
Paginated Results
API responses are divided into pages. While page size may vary and is not guaranteed, it typically includes around 100 elements.
When additional pages are available, the response includes a nextPagePostBody element. This element replicates the parameters of the initial request for convenience and adds a pointer to the next page.
To retrieve the next page, submit another POST request to the same endpoint using the nextPagePostBody as the request body. Continue this process until the response no longer contains a nextPagePostBody element.
The following is example output that contains the nextPagePostBody:
{
"items": [ ... ]
...
"nextPagePostBody": {
"granularity": "step",
"progress": [
"completed",
"abandoned",
"ongoing"
],
"startTime": "2025-04-21T22:00:00.000Z",
"endTime": "2025-10-22T21:59:59.999Z",
"latestStepState": true,
"page": 2
}
}
The next POST call to be made, would be the following:
POST https://vuforia.portal.ptc.com/customer-events/<orgId>/report
{
"granularity": "step",
"progress": [
"completed",
"abandoned",
"ongoing"
],
"startTime": "2025-04-21T22:00:00.000Z",
"endTime": "2025-10-22T21:59:59.999Z",
"latestStepState": true,
"page": 2
}