In diesem Artikel wird die Verwendung der API für Berichte v2 erläutert. 2025 haben wir die neue Version unseres Berichts-Builders vorgestellt. Die API für Berichte v2 bietet Zugriff auf alle Daten und Funktionen des neuen Berichts-Builders.

Die API für Berichte v2 ersetzt die API für individuelle Berichte v1. Wenn Sie die alte Version verwenden, informieren wir Sie per E-Mail über die Übergangsphase und das geplante Datum der Entfernung.
 

Bevor Sie beginnen

Zum Abschließen der Einrichtung benötigen Sie Adminberechtigungen. Möglicherweise benötigen Sie auch Support von Ihrer IT-Abteilung oder Ihrem Integrationsteam.

Den Schritt zu v2 verstehen

Die neue API für Berichte v2 entspricht den Funktionen der alten Version und umfasst Verbesserungen. Wie bisher können Sie Berichte einzeln anhand der Berichts-ID abfragen.

Das ist neu bei v2:

• Sie ist schneller und effizienter im Umgang mit großen Datensätzen.
• Über ein neues Drop-down-Menü können Sie gezielt auswählen, welche Berichte über die API verfügbar gemacht werden sollen. Beachten Sie, dass nur Admins Berichte für den API-Zugriff auswählen können.
• Admins profitieren von einer besseren Sichtbarkeit und Kontrolle über eine neue API-Berichtsliste, auch wenn sie nicht der Verantwortliche für einen Bericht sind. Sie können weiterhin nur Berichte öffnen, die für Sie freigegeben werden oder für die Sie verantwortlich sind.
• Historische individuelle Berichte enthalten nun den Vor- und Nachnamen. Sie müssen diese Informationen nicht separat über die Mitarbeiter-API abrufen. Die v2 zeigt die genauen Daten, die Sie in der Benutzeroberfläche sehen.
• Es gibt eine bessere Filterunterstützung (bisher war nur IST oder IST NICHT möglich).

Beachten Sie Folgendes:

• Wir planen, die API für individuelle Berichte v1 zu entfernen. Den genauen Zeitplan teilen wir Ihnen per E-Mail mit.
• Weitere Funktionen folgen in Kürze, darunter Rohdatenabfragen sowie Endpunkte zum Erstellen/Aktualisieren/Löschen für die Verwaltung von Berichten über die API.

Schritt 1: Individuelle Integration aktualisieren oder eine neue erstellen

Um die API für Berichte v2 verwenden zu können, müssen Sie entweder Ihre aktive individuelle Integration aktualisieren oder eine neue erstellen.

Ihre individuelle Integration aktualisieren

Wenn Sie die Integration aktualisieren, können Sie weiterhin Ihre vorhandenen API-Zugriffsdaten verwenden.

Befolgen Sie diese Schritte:

1. Gehen Sie auf Einstellungen > Sicherheit & Integrationen > API-Zugriffsdaten .
2. Wählen Sie die entsprechende individuelle Integration und aktivieren Sie den Lesezugriff für Berichte.
3. Klicken Sie auf Aktualisieren.
4. Die neue Berichts-API ist nun aktiviert und Sie können Berichte zur Verfügung stellen.

Neue individuelle Integration einrichten

In unserem speziellen Artikel im Help Center sind die Anforderungen für die Einrichtung einer individuellen Integration dargelegt.

1. Gehen Sie auf Einstellungen > Sicherheit & Integrationen > API-Zugriffsdaten .
2. Klicken Sie auf Individuelle Integration erstellen.
3. Aktivieren Sie den Lesezugriff für Berichte.
4. Hinweise zur Einrichtung einer individuellen Integration finden Sie im Developer Hub.

Schritt 2: Berichte über die API im Bereich Analysen verfügbar machen

Sie müssen die für die API verfügbaren Berichte beurteilen und aktivieren. Falls die Schaltfläche API-Zugriff verwalten nicht angezeigt wird, gehen Sie zurück zu Schritt 1 und aktualisieren Sie die Integration. Die Schaltfläche ist erst verfügbar, wenn die Integration mit aktivierter API für Berichte v2 gespeichert wurde.

So funktioniert es:

• Individuelle Berichte bleiben über die API für individuelle Berichte v1 verfügbar. Sie können den Zugriff darauf nicht deaktivieren.
• Berichte, die Sie mit dem neuen Berichts-Builder erstellen, sind über die API für Berichte v2 verfügbar.

Sie können nur Berichte sehen, die für Sie freigegeben werden oder für die Sie verantwortlich sind. Überprüfen Sie Ihre Berichtsliste und aktivieren Sie die Berichte, die Sie für die API bereitstellen möchten. 

Befolgen Sie diese Schritte:

1. Navigieren Sie zu Analysen > Berichte.
2. Aktivieren Sie das Kontrollkästchen neben dem entsprechenden Bericht.
3. Klicken Sie auf API-Zugriff verwalten.
4. Wählen Sie im Drop-down-Menü Aktiviert aus.
5. Speichern Sie Ihre Änderungen.

Schritt 3: Ihre API-Integration aktualisieren und die erforderlichen Änderungen vornehmen

Gehen Sie wie folgt vor, um Ihre API-Integration zu aktualisieren und die erforderlichen Änderungen vorzunehmen:

1. Passen Sie Ihren Integrationscode an, um die Endpunkte der neuen API für Berichte v2 für aktivierte Berichte zu verwenden.
2. Aktualisieren Sie Ihre API-Anfragen und Authentifizierung, um „Lesezugriff für Berichte“ einzuschließen.
3. Testen Sie Ihre Integration, um sicherzustellen, dass Sie die erwarteten Berichtsdaten erhalten.

Technische Details und Beispielabfragen finden Sie in unserem Developer Hub sowie in der Dokumentation zur API für Berichte v2.