Erhalten Sie Fragen und Antworten über die Perform & Engage 365 API

Die Perform & Engage 365 API ermöglicht Ihnen Folgendes:

• Eine Liste der Fragen abrufen.
• Die Details einer bestimmten Frage anhand ihrer ID abrufen.
• Eine Liste der Antworten auf eine bestimmte Frage abrufen.
• Die Details einer bestimmten Antwort anhand ihrer ID abrufen.

Eine Liste der Fragen abrufen

GET /api/v2/questions/

Mit dieser Anfrage können Sie eine Liste der Fragen abrufen.

Optionale Abfrageparameter

• limit (integer). Die maximale Anzahl der Fragen 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/questions/

Parameter des Antworttexts

Der Antworttext enthält:

• count (integer). Die Anzahl der Ergebnisse.
• Next und Previous (strings). URLs zu den nächsten und vorherigen Seiten (wenn Sie in der ursprünglichen Anfrage Paginierung verwendet haben).
• results (array). Die Liste der Fragen. Jede Frage hat diese Parameter:
  • api_id (string). Die Frage-ID. Sie können diese ID verwenden, um weitere Details zur Frage abzurufen.
  • text (string). Der Fragetext.
  • type (string). Der Fragetyp. Die möglichen Typen sind:
    • choice: Ein:e Mitarbeiter:in wählt zwischen einer oder mehreren Optionen.
    • Bewertung: Ein:e Mitarbeiter:in wählt die Bewertung innerhalb des Zahlenbereichs, zum Beispiel von 1 bis 10.
    • text: Ein:e Mitarbeiter:in gibt eine Antwort als Text ein.
    • yes/no: Ja/Nein-Fragen.
    • recognition: Ein:e Mitarbeiter:in gibt eine Antwort als Text ein, in der andere Kolleg:innen erwähnt werden können.
  • choices (Array). Beim Fragetyp choice enthält das Array eine Liste möglicher Auswahloptionen. Jede Auswahloption hat die String-Parameter api_id und text . Bei anderen Fragetypen ist das Array leer.

Beispiel für den Antworttextkörper

Die erfolgreiche 200-Antwort gibt einen Antworttextkörper zurück, der in etwa so aussieht:

{
 "count": 1,
 "next": null,
 "previous": null,
 "results": [
   {
     "api_id": "580:396cd5f1-d52b-4cfc-bcc6-610e17697a86",
     "text": "Wie einfach finden Sie die Kommunikation mit Kolleginnen und Kollegen beim Arbeiten aus dem Homeoffice?",
     "type": "choice",
     "choices": [
       {
         "api_id": "580:5f48d723-9987-4b04-9d8e-716dfc1ef704",
         "text": "Sehr schwierig"
       },
       {
         "api_id": "580:8aec8072-b434-4108-8c66-f5dcf00e7681",
         "text": "Schwierig"
       },
       {
         "api_id": "580:4a05e53f-1414-4d43-8c8a-2f3f34e88e33",
         "text": "Nicht sicher"
       },
       {
         "api_id": "580:f96620ed-830c-4679-9702-0d4a925653cc",
         "text": "Einfach"
       },
       {
         "api_id": "580:edb008f6-4322-4bc4-90f8-3aea07532762",
         "text": "Sehr einfach"
       }
     ]
   }
 ]
}

Details zu einer bestimmten Frage anhand ihrer ID abrufen

GET api/v2/questions/{api_id}/

Nachdem Sie die api_id der Frage in der Antwort auf die vorherige Anfrage erhalten haben, können Sie diese ID verwenden, um Informationen zur Frage abzurufen.

Erforderlicher Pfadparameter

• api_id (String). Die Fragen-ID erhalten Sie, indem Sie die GET-Anfrage /api/v2/questions/ senden.

Beispielanfrage

GET /api/v2/questions/580%3A396cd5f1-d52b-4cfc-bcc6-610e17697a86

Parameter des Response-Bodys

Die GET-Response api/v2/questions/{api_id}/ enthält dieselben Parameter wie das results-Array in der GET-Response /api/v2/questions/.

Beispiel für den Response-Body

Die erfolgreiche 200-Response liefert einen Body, der etwa so aussieht:

{
 "api_id": "580:396cd5f1-d52b-4cfc-bcc6-610e17697a86",
 "text": "Wie einfach fällt Ihnen die Kommunikation mit Kolleginnen und Kollegen beim Arbeiten aus dem Homeoffice?",
 "type": "choice",
 "choices": [
   {
     "api_id": "580:5f48d723-9987-4b04-9d8e-716dfc1ef704",
     "text": "Sehr schwierig"
   },
   {
     "api_id": "580:8aec8072-b434-4108-8c66-f5dcf00e7681",
     "text": "Schwierig"
   },
   {
     "api_id": "580:4a05e53f-1414-4d43-8c8a-2f3f34e88e33",
     "text": "Nicht sicher"
   },
   {
     "api_id": "580:f96620ed-830c-4679-9702-0d4a925653cc",
     "text": "Einfach"
   },
   {
     "api_id": "580:edb008f6-4322-4bc4-90f8-3aea07532762",
     "text": "Sehr einfach"
   }
 ]
}

Eine Liste der Antworten auf eine bestimmte Frage abrufen

GET /api/v2/questions/{question_api_id}/responses/

Mit dieser Anfrage können Sie eine Liste der Antworten auf eine bestimmte Frage abrufen.

Erforderlicher Pfadparameter

• question_api_id (Zeichenkette). Die Fragen-ID erhalten Sie, indem Sie die GET-Anfrage /api/v2/questions/ senden.

Optionale Query-Parameter

• date_from (Zeichenkette). Das Starten-Datum, ab dem die Antworten zurückgegeben werden. Das Format ist yyyy-mm-dd.
• date_to (Zeichenkette). Das Datum, bis zu dem die Antworten zurückgegeben werden. Das Format ist yyyy-mm-dd.
• department (Zeichenkette). Die Abteilung, zu der der Mitarbeiter gehört.
• manager_email (Zeichenkette). Die E-Mail-Adresse des Vorgesetzten des Mitarbeiters.
• manager_name (string). Der vollständige Name des Managers des Mitarbeiters.
• person_email (string). Die E-Mail-Adresse des Mitarbeiters.
• person_name (string). Der vollständige Name des Mitarbeiters.
• limit (integer). Die maximale Anzahl von Antworten in der API-Antwort.
• offset (integer). Der Startindex, ab dem die Ergebnisse in der API-Antwort zurückgegeben werden.

Beispielanfrage

GET /api/v2/questions/580%3A396cd5f1-d52b-4cfc-bcc6-610e17697a86/
responses/?date_from=2025-01-25&department=Research%20and%20Development&
manager_name=Joanne%20Stefani&person_name=Michael%20Test

Parameter des Antwort-Bodys

Der Antwort-Body enthält:

• count (integer). Die Anzahl der Ergebnisse.
• next und previous (strings). URLs zu den nächsten und vorherigen Seiten (falls Sie in der ursprünglichen Anfrage Paginierung verwendet haben).
• results (array). Die Liste der Antworten. Jede Antwort enthält diese Parameter:
  • api_id (string). Die Antwort-ID. Sie können diese ID verwenden, um weitere Details zur Antwort abzurufen.
  • response_date (string). Datum und Uhrzeit der Antwort.
  • person_name (String). Der vollständige Name des Mitarbeiters.
  • person_api_id (String). Die ID des Mitarbeiters.
  • person_email (String). Die E-Mail-Adresse des Mitarbeiters.
  • person_department (String). Die Abteilung, zu der der Mitarbeiter gehört.
  • person_properties (Array). Das Array enthält die Eigenschaften des Mitarbeiters als Name- und Wert-Paar von String-Parametern. Zum Beispiel könnte es die Rolle des Mitarbeiters im Unternehmen sein.

Beispiel für den Antworttext

Die erfolgreiche 200-Antwort gibt einen Text zurück, der in etwa wie folgt aussieht:

{
 "count": 1,
 "next": null,
 "previous": null,
 "results": [
   {
     "api_id": "580:96537590-1b02-4fe9-bf57-0d0932c5141a",
     "response_date": "2024-07-12T05:55:59.654671+01:00",
     "person_name": "Mitarbeiter Person",
     "person_api_id": "580:cf9cc7db-36a9-4b1c-b530-15c3f3d02926",
     "person_email": "adelevance+employee@test.com",
     "person_department": "Personalwesen",
     "person_properties": [
       {
         "name": "Name",
         "value": "People and Culture Manager"
       }
     ]
   }
]
}

Details zu einer bestimmten Antwort anhand ihrer ID abrufen

GET api/v2/questions/{api_id}/responses/{api_id}/

Nachdem Sie die api_id einer Antwort auf eine bestimmte Frage aus der Antwort auf die vorherige Anfrage erhalten haben, können Sie diese ID verwenden, um Informationen zur Antwort auf die Frage abzurufen.

Erforderliche Pfadparameter

• api_id (String). Die Antwort-ID, die Sie erhalten, indem Sie die GET-Anfrage /api/v2/questions/{question_api_id}/responses/ senden.
• question_api_id (String). Die Frage-ID, die Sie erhalten, indem Sie die GET-Anfrage /api/v2/questions/ senden.

Beispielanfrage

GET /api/v2/questions/580%3A5750042d-0076-4c67-bac0-d7900a2cfbd4/responses/
580%3A96537590-1b02-4fe9-bf57-0d0932c5141a

Parameter im Antwort-Body

Die Antwort des GET api/v2/questions/{api_id}/responses/{api_id}/ enthält dieselben Parameter wie das results-Array in der Antwort auf GET /api/v2/questions/{question_api_id}/responses/.

Beispiel für den Antworttext

Die erfolgreiche 200-Antwort gibt einen Antwort-Body ähnlich dem folgenden zurück:

{
 "api_id": "580:96537590-1b02-4fe9-bf57-0d0932c5141a",
 "response_date": "2024-07-12T05:55:59.654671+01:00",
 "person_name": "Mitarbeiter Person",
 "person_api_id": "580:cf9cc7db-36a9-4b1c-b530-15c3f3d02926",
 "person_email": "adelevance+employee@test.com",
 "person_department": "Personalwesen",
 "person_properties": [
   {
     "name": "Rolle",
     "value": "People and Culture Manager"
   }
 ]
}