Ziele und OKRs über die Perform & Engage 365 API abrufen

Mit der Perform & Engage 365 API können Sie:

• Eine Liste von Zielen und OKRs abrufen.
• Die Details zu einem bestimmten Ziel oder OKR anhand seiner ID abrufen.

Eine Liste von Zielen und OKRs abrufen

GET /api/v2/goals/

Mit dieser Anfrage können Sie eine Liste von Zielen, Unterzielen, OKRs und OKR-Schlüsselergebnissen abrufen.

Optionale Abfrageparameter

• limit (Integer). Die maximale Anzahl an Zielen, Unterzielen, OKRs und OKR-Schlüsselergebnissen in der Antwort.
• offset (Integer). Der Startindex, ab dem die Ergebnisse in der Antwort zurückgegeben werden.

Beispiel für eine Anfrage

GET /api/v2/goals/

Parameter des Antwort-Bodys

Der Antwort-Body enthält:

• count (Integer). Die Anzahl der Ergebnisse.
• Weiter und Zurück (Strings). URLs zu den nächsten und vorherigen Seiten (falls Sie in der ursprünglichen Anfrage Paginierung verwendet haben).
• results (Array). Dieses Array enthält eine Liste von Zielen, Unterzielen, OKRs und OKR-Schlüsselergebnissen. Jedes Element hat diese Parameter:
  • api_id (String). Die Ziel- oder OKR-ID. Sie können diese ID verwenden, um weitere Details zum Ziel oder OKR zu erhalten.
  • Titel_Name (string). Der Ziel- oder OKR-Titel.
  • description (string). Die Ziel- oder OKR-Beschreibung.
  • department (string). Die Abteilung, für die das Ziel oder OKR festgelegt ist.
  • team_manager_name (string). Der vollständige Name der Führungskraft des Teams, für das das Ziel oder OKR festgelegt ist.
  • person_name (string). Der vollständige Name der Mitarbeiterin bzw. des Mitarbeiters, für die bzw. den das Ziel oder OKR festgelegt ist.
  • person_group_name (string). Der Name der Mitarbeitergruppe, für die das Ziel oder OKR festgelegt ist.
  • responsible_person_name (string). Der vollständige Name der Person, die für die Aktualisierung des Fortschritts des Ziels oder OKR verantwortlich ist.
  • unit (string). Die für das Ziel oder OKR verwendete Metrik. Mögliche Metriken sind:
    • perc (Prozentsatz).
    • number.
    • bin (binär) bedeutet, dass das Ziel entweder abgeschlossen ist oder nicht.
    • ISO-4217-Währungscodes, z. B. usd oder eur.
• baseline_value (string). Die Zahl, ab der der Fortschritt des Ziels startet.
• target_value (string). Die Zahl, deren Erreichen das Ziel abschließt.
• current_value (string). Der aktuelle Zielfortschritt.
• start_date (string). Das Startdatum des Ziels oder OKR.
• target_date (string). Das Datum, bis zu dem das Ziel oder OKR erreicht werden soll.
• is_complete (boolean). Gibt an, ob das Ziel oder OKR abgeschlossen (true) ist oder nicht (false).
• rag_status (string). Der aktuelle Status des Ziels oder OKR in der RAG-Fortschrittsberechnung (rot, gelb, grün).  
• auto_calculated (boolean). Gibt an, ob der Fortschritt des Ziels oder OKR automatisch (true) oder manuell (false) berechnet wird.
• is_okr (boolean). Gibt an, ob das Element ein OKR (true) oder ein Ziel (false) ist.
• goal_weight (integer). Die Gewichtung des Ziels, Teilziels, OKR oder OKR-Schlüsselergebnisses. Wenn zum Beispiel das Teilziel A die Gewichtung 3 hat und das Teilziel B die Gewichtung 1, aktualisiert der Abschluss des Teilziels A den Fortschritt des gesamten Ziels auf 75%.
• goal_visibility (string). Es gibt zwei Sichtbarkeitsoptionen, public und lineofsight. Lineofsight bedeutet, dass das Ziel oder OKR entsprechend der Hierarchie sichtbar ist; ein Teamziel ist zum Beispiel nur für Mitarbeitende des Teams sichtbar. Public bedeutet, dass das Ziel oder OKR für alle in der Organisation sichtbar ist, wenn sie nach diesem Ziel oder OKR filtern und suchen.
• rag_target_based (boolean). Gibt an, ob die RAG-Fortschrittsberechnung (rot, gelb, grün) zielbasiert (true) oder zeitbasiert (false) ist.

Beispiel für den Response-Body

Bei einer erfolgreichen 200-Antwort sieht der Textkörper etwa so aus:

{
 "count": 1,
 "next": null,
 "previous": null,
 "results": [
   {
     "api_id": "580:fef0d7fb-c87a-4607-936f-7a87f9bad6d6",
     "Titel": "Umsatz um 20% steigern",
     "description": "",
     "department": null,
     "team_manager_name": null,
     "person_name": "Joanne Stefani",
     "person_group_name": null,
     "responsible_person_name": null,
     "unit": "perc",
     "baseline_value": "0.0000",
     "target_value": "100.0000",
     "current_value": "20.0000",
     "start_date": "2025-01-01",
     "target_date": "2025-12-31",
     "is_complete": false,
     "rag_status": "RED",
     "auto_calculated": false,
     "is_okr": false,
     "goal_weight": 1,
     "goal_visibility": "lineofsight",
     "rag_target_based": false
   }
]
}

Rufen Sie die Details eines bestimmten Ziels oder OKR anhand seiner ID ab

GET api/v2/goals/{api_id}/

Nachdem Sie in der Antwort auf die previous request die Ziel- oder OKR api_id erhalten haben, können Sie diese ID verwenden, um weitere Informationen zum Ziel oder OKR abzurufen.

Erforderlicher Pfadparameter

• api_id (Zeichenkette). Die Ziel-, Unterziel-, OKR- oder OKR-Key-Result-ID, die Sie erhalten, indem Sie die GET-Anfrage /api/v2/goals/ senden.

Beispielanfrage

GET /api/v2/goals/580%3Afef0d7fb-c87a-4607-936f-7a87f9bad6d6

Parameter des Antworttextkörpers

Die Antwort auf die GET-Anfrage api/v2/goals/{api_id}/ enthält dieselben Parameter wie das results-Array in der Antwort auf die GET-Anfrage /api/v2/goals/.

Beispiel für den Antworttextkörper

Bei einer erfolgreichen 200-Antwort sieht der Textkörper etwa so aus:

{
 "api_id": "580:fef0d7fb-c87a-4607-936f-7a87f9bad6d6",
 "Titel": "Umsatz um 20% steigern",
 "description": "",
 "department": null,
 "team_manager_name": null,
 "person_name": "Joanne Stefani",
 "person_group_name": null,
 "responsible_person_name": null,
 "unit": "perc",
 "baseline_value": "0.0000",
 "target_value": "100.0000",
 "current_value": "20.0000",
 "start_date": "2025-01-01",
 "target_date": "2025-12-31",
 "is_complete": false,
 "rag_status": "RED",
 "auto_calculated": false,
 "is_okr": false,
 "goal_weight": 1,
 "goal_visibility": "lineofsight",
 "rag_target_based": false
}