Engagement-Umfragen über die Perform & Engage 365 API abrufen

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

• Eine Liste der Engagement-Umfragen abrufen.
• Details zu einer bestimmten Engagement-Umfrage anhand ihrer ID abrufen.

Eine Liste der Engagement-Umfragen abrufen

GET /api/v2/engagement_surveys/

Mit dieser Anfrage können Sie eine Liste der Engagement-Umfragen abrufen.

Optionale Abfrageparameter

• Sortieren (string). Die Sortierung der Ergebnisse. Mögliche Werte sind:
  • submitted_count. Die Engagement-Umfragen werden von der niedrigsten zur höchsten Anzahl an abgegebenen Antworten sortiert (aufsteigend).
  • -submitted_count. Die Engagement-Umfragen werden von der höchsten zur niedrigsten Anzahl an abgegebenen Antworten sortiert (absteigend).
• status (string). Der Status der Engagement-Umfrage. Mögliche Werte sind:
  • draft. Unveröffentlichte Umfragen.
  • published. Veröffentlichte Umfragen mit einem Startdatum in der Zukunft.
  • aktiv. Veröffentlichte Umfragen mit einem Startdatum in der Vergangenheit oder heute.
  • past. Veröffentlichte Umfragen, deren Enddatum in der Vergangenheit liegt.
• limit (Ganzzahl). Die maximale Anzahl von Engagement-Umfragen in der Antwort.
• offset (Ganzzahl). Der Startindex, ab dem die Ergebnisse in der Antwort zurückgegeben werden.

Beispielanfrage

GET /api/v2/engagement_surveys/?limit=10&ordering=-submitted_count&status=active

Parameter des Antworttexts

Der Antworttext umfasst:

• count (Ganzzahl). Die Anzahl der Ergebnisse.
• next und previous (Zeichenfolgen). URLs zu den nächsten und vorherigen Seiten (falls Sie in der ursprünglichen Anfrage Paginierung verwendet haben).
• results (Array). Die Liste der Engagement-Umfragen. Jede Engagement-Umfrage hat die folgenden Parameter:
  • api_id (Zeichenfolge). Die ID der Engagement-Umfrage. Sie können diese ID verwenden, um weitere Details zur Engagement-Umfrage abzurufen.
  • name (Zeichenfolge). Der Name der Engagement-Umfrage.
  • recipients_count (Ganzzahl). Die Anzahl der Empfängerinnen und Empfänger der Engagement-Umfrage.
  • recipients (Array). Die Liste der Empfängerinnen und Empfänger. Jeder Empfänger hat diese Parameter:
    • api_id (string). Die Benutzer-ID des Empfängers.
    • name (string). Der vollständige Name des Empfängers.
    • E-Mail (string). Die E-Mail-Adresse des Empfängers.
    • Abteilung (string). Die Abteilung, zu der der Empfänger gehört.
    • Team (string). Das Team, zu dem der Empfänger gehört.
  • submitted_count (integer). Die Anzahl der eingereichten Engagement-Umfrageantworten.
  • Status (string). Der Status der Engagement-Umfrage. Eine Liste der möglichen Status finden Sie in der Beschreibung der Abfrageparameter.
  • questions (array). Die Liste der Fragen, die die Engagement-Umfrage enthält. Jede Frage hat die String-Parameter text und api_id.

Beispiel für den Antworttext

Die erfolgreiche 200-Antwort enthält einen Antworttext, der etwa so aussieht:

{
  "count": 1,
  "next": null,
  "previous": null,
  "results": [
    {
      "api_id": "9fe6621c-bbba-4160-abcd-9a3b80f0ce3d",
      "name": "Engagement-Umfrage-Tarif",
      "recipients": [
        {
          "api_id": "69da2b54-eaa9-467d-9027-7e4597cbf785",
          "name": "Joanne Stefani",
          "email": "jstefani@test.com",
          "department": "IT Team",
          "team": "Joannes Team"
        }
      ],
      "status": "aktiv",
      "recipients_count": 1,
      "submitted_count": 0,
      "questions": [
        {
          "text": "Ich würde meine Organisation Menschen, die ich respektiere, als einen großartigen Arbeitsplatz empfehlen.",
          "api_id": null
        },
        {
          "text": "Ich denke selten darüber nach, meine Organisation zu verlassen, um woanders zu arbeiten.",
          "api_id": null
        },
        {
          "text": "In meiner Organisation fühle ich mich inspiriert, mein Bestes zu geben.",
          "api_id": null
        }
      ]
    }
  ]
}

Rufen Sie die Details einer bestimmten Engagement-Umfrage anhand ihrer ID ab

GET api/v2/engagement_surveys/{api_id}/

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

Erforderlicher Pfadparameter

• api_id (string). Die ID der Engagement-Umfrage, die Sie erhalten, indem Sie die GET-Anfrage /api/v2/engagement_surveys/ senden.

Anfragebeispiel

GET /api/v2/engagement_surveys/9fe6621c-bbba-4160-abcd-9a3b80f0ce3d/

Parameter des Response-Bodys

Die Response auf GET api/v2/engagement_surveys/{api_id}/ enthält dieselben Parameter wie das results-Array in der Response auf GET /api/v2/engagement_surveys/. Außerdem enthält jedes questions-Array das responses-Array, eine Liste der Antworten auf die Frage. Jede Antwort hat diese Parameter:

• response (Array oder Boolean, je nach Frage). Die Antwort, die der Empfänger eingereicht hat.
• submission_date (string). Datum und Uhrzeit der Einreichung der Antwort auf die Frage.

Beispiel für den Response-Body

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

{
      "api_id": "9fe6621c-bbba-4160-abcd-9a3b80f0ce3d",
      "name": "Engagement-Umfrage-Tarif",
      "recipients": [
        {
          "api_id": "69da2b54-eaa9-467d-9027-7e4597cbf785",
          "name": "Joanne Stefani",
          "email": "jstefani@test.com",
          "department": "IT Team",
          "team": "Joannes Team"
        }
      ],
      "status": "Aktiv",
      "recipients_count": 1,
      "submitted_count": 1,
      "questions": [
        {
          "text": "Ich würde meine Organisation Menschen, die ich respektiere, als einen großartigen Arbeitsplatz empfehlen.",
          "api_id": null,
          "responses": [
          {
            "response": true,
            "submission_date": "2025-08-05T15:58:05.963698+01:00"
          }
          ]
        },
        {
          "text": "Ich denke selten darüber nach, meine Organisation zu verlassen, um woanders zu arbeiten.",
          "api_id": null,
          "responses": [
          {
            "response": true,
            "submission_date": "2025-08-05T15:58:05.963698+01:00"
          }
          ]
        },
        {
          "text": "In meiner Organisation fühle ich mich inspiriert, mein Bestes zu geben.",
          "api_id": null,
          "responses": [
          {
            "response": false,
            "submission_date": "2025-08-05T15:58:05.963698+01:00"
          }
         ]
        }
      ]
    }