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.
|
|
This setting affects all APIs that return textual data.
|
|
|
|
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
Appendix.
|
|
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:
