API-Aufruf durchführen
PII und proprietäre Daten in API-Aufrufen
Die Sichtbarkeit aller PII und proprietärer Daten kann in den Vuforia Einstellungen über die folgenden Einstellungen festgelegt werden:
|
Einstellung
|
Informationen
|
||
|---|---|---|---|
|
Wenn diese Einstellung deaktiviert ist, gilt Folgendes:
• Verfahrensinformationen (Verfahrenstitel, Benutzerkommentare) werden entfernt.
• Schrittinformationen (Schrittbeschreibung, Schritttitel, Benutzerkommentare und Medien-Feedback) werden entfernt.
• Benutzerinformationen (Vorname, Nachname, E-Mail-Adresse und Rolle) werden entfernt.
Diese Einstellung ist standardmäßig deaktiviert.
Ist diese Einstellung aktiviert, so werden die obigen Daten nicht entfernt.
|
|||
|
Ist diese Einstellung aktiviert, so hat dies Auswirkungen auf die zurückgegebenen Daten.
Diese Einstellung ist standardmäßig deaktiviert.
|
 |
In Situationen, in denen diese beiden Einstellungen miteinander in Konflikt stehen, werden Informationen entfernt oder gekürzt.
|
API-Aufruf
Sie können API-Aufrufe an die API /customer-events/<org id>/report durchführen, die Sitzungsdaten für eine angegebene Organisation zurückgibt. Die Ergebnisse können mithilfe von Abfrageparametern gefiltert werden. Die folgenden Abfrageparameter können nützlich sein:
• feedback
• serialNumber
• failures
• progress
Weitere Informationen zu den obigen Parametern finden Sie unter Verfügbare Parameter.
 |
Für optimale Ergebnisse sollten URL-Parameter kodiert werden, da einige Zeichen ohne Kodierung nicht funktionieren. Beispiel: Die Seriennummer lautet 'serial$number#with|special&chars'. Die kodierte Version, die sicher ist und als URL-Parameter verwendet werden sollte ist 'serial%24number%23with%7Cspecial%26chars',.
|
Es sind folgende Beispiele verfügbar:
Paginierte Ergebnisse
API-Antworten sind in Seiten unterteilt. Die Seitengröße kann variieren und ist nicht garantiert. In der Regel enthält eine Seite etwa 100 Elemente.
Wenn zusätzliche Seiten verfügbar sind, enthält die Antwort ein nextPagePostBody-Element. Dieses Element repliziert der Einfachheit halber die Parameter der ursprünglichen Anforderung und fügt einen Verweis auf die nächste Seite hinzu.
Senden Sie eine weitere POST-Anforderung an denselben Endpunkt, um die nächste Seite abzurufen. Verwenden Sie hierzu nextPagePostBody als Anforderungstext. Fahren Sie so lange fort, bis die Antwort kein nextPagePostBody-Element mehr enthält.
Nachfolgend finden Sie eine Beispielausgabe mit 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
}
}
Der nächste POST-Aufruf würde wie folgt aussehen:
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
}