进行 API 调用
API 调用中的 PII 和专有数据
可通过以下 Vuforia 设置控制所有 PII 和专有数据的可见性：
|
设置
|
信息
|
||
|---|---|---|---|
|
禁用此设置后，其影响如下：
• 过程信息（过程标题、用户备注）将被隐去
• 步骤信息（步骤说明、步骤标题、用户备注和媒体反馈）将被隐去
• 用户信息（名字、姓氏、电子邮件和角色）将被隐去
默认情况下，此设置处于禁用状态。
启用此设置后，以上数据不会被隐去。
|
|||
|
启用此设置后，返回的数据将受到影响。
默认情况下，此设置处于禁用状态。
|
 |
如果这两个设置彼此冲突，则首选隐去或缩短信息。
|
API 调用
可以调用 /customer-events/<orgid>/report API 以返回指定组织的会话数据。随后可使用查询参数对结果进行筛选。下列查询参数可能发挥作用：
• feedback
• serialNumber
• failures
• progress
有关上述参数的更多详情，请参阅可用参数 。
 |
为获得最佳结果，应对 URL 参数进行编码，因为某些字符不经过编码将无法正常工作。例如，如果序列号为 'serial$number#with|special&chars'，则建议用作 URL 参数的安全编码版本为 'serial%24number%23with%7Cspecial%26chars'。
|
以下示例可供参考：
• 返回所有过程数据
分页结果
API 响应可分为多个页面。虽然页面大小可能会变化，但它通常包括大约 100 个元素。
当其他页面可用时，响应将包含 nextPagePostBody 元素。为方便起见，此元素将复制初始请求的参数，并添加指向下一页的指针。
要检索下一页，请以 nextPagePostBody 作为请求正文，向同一端点提交另一个 POST 请求。继续此过程，直到响应不再包含 nextPagePostBody 元素。
以下是包含 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
}
}
下一个 POST 调用大致如下：
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
}