Check-ins über die Perform & Engage 365 API abrufen

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

• Eine Liste der Check-ins abrufen.
• Die Details eines bestimmten Check-ins anhand seiner ID abrufen.

Eine Liste der Check-ins abrufen

GET /api/v2/checkins/

Mit dieser Anfrage können Sie anhand der Suchparameter eine Liste von Check-ins abrufen.

Optionale Abfrageparameter

• date_from (string). Das Einreichungsdatum des Check-ins, ab dem die Ergebnisse zurückgegeben werden. Das Format ist yyyy-mm-dd.
• date_to (string). Das Einreichungsdatum des Check-ins, bis zu dem die Ergebnisse zurückgegeben werden. Das Format ist yyyy-mm-dd.
• department (string). Die Abteilung, der der Mitarbeiter angehört.
• manager_email (string). 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 an Check-ins in einer Antwort.
• offset (Ganzzahl). Der Startindex, ab dem die Ergebnisse in der Antwort zurückgegeben werden.

Anfragebeispiel

GET /api/v2/checkins/?date_from=2025-01-25&department=Research%20and%20Development
&manager_name=Joanne%20Stefani&person_name=Michael%20Test'

Parameter des Antworttexts

Der Antworttext enthält:

• count (Ganzzahl). Die Anzahl der Ergebnisse.
• Weiter und Zurück (Zeichenketten). URLs zur Weiter- und Zurück-Seite (falls Sie in der ursprünglichen Anfrage Paginierung verwendet haben).
• results (Array). Die Liste der Check-ins. Jeder Check-in hat diese Parameter:
  • api_id (Zeichenkette). Die Check-in-ID. Sie können diese ID verwenden, um weitere Details zum Check-in abzurufen.
  • deadline_date (Zeichenkette). Datum und Uhrzeit der Check-in-Frist.
  • submission_date (Zeichenkette). Datum und Uhrzeit der Check-in-Abgabe.
  • überfällig (Boolesch). Gibt an, ob der Check-in überfällig (true) ist oder nicht (false).
  • on_vacation (Boolesch). Gibt an, ob der Mitarbeiter während des Fälligkeitszeitpunkts des Check-ins im Urlaub war (true) oder nicht (false).
  • is_adhoc (boolean). Gibt an, ob das Check-in ad hoc (true) oder geplant (false) war.

Beispiel für den Antwort-Body

Die erfolgreiche 200-Antwort enthält einen Body, der ungefähr so aussieht:

{
 "count": 2,
 "Weiter": null,
 "Zurück": null,
 "results": [
   {
     "api_id": "580:ce417c60-30ca-4e39-967e-b258d496be30",
     "deadline_date": "2025-04-12T00:59:59+01:00",
     "submission_date": "2025-04-11T12:06:00.882601+01:00",
     "überfällig": false,
     "on_vacation": false,
     "is_adhoc": true
   },
   {
     "api_id": "580:c9b26b5e-f9b5-4b5f-8525-5b706ce891ba",
     "deadline_date": "2025-04-11T12:00:00+01:00",
     "submission_date": "2025-04-11T12:19:00.405628+01:00",
     "überfällig": false,
     "on_vacation": false,
     "is_adhoc": false
   }
 ]
}  

Rufe die Details eines bestimmten Check-ins anhand der ID ab

GET api/v2/checkins/{api_id}/

Nachdem du in der Antwort auf die vorherige Anfrage die Check-in-api_id erhalten hast, kannst du diese ID verwenden, um weitere Informationen zum Check-in abzurufen.

Erforderlicher Pfadparameter

• api_id (Zeichenkette). Die Check-in-ID, die du durch Senden der Anfrage GET /api/v2/checkins/ erhalten kannst.

Beispiel für die Anfrage

GET /api/v2/checkins/580%3Ace417c60-30ca-4e39-967e-b258d496be30/

Parameter im Antwort-Body

Der Antwort-Body enthält:

• api_id (Zeichenkette). Die Check-in-ID.
• deadline_date (Zeichenkette). Datum und Uhrzeit der Check-in-Frist.
• submission_date (Zeichenkette). Datum und Uhrzeit der Einreichung des Check-ins.
• überfällig (Boolesch). Gibt an, ob das Check-in überfällig (true) ist oder nicht (false).
• on_vacation (Boolesch). Gibt an, ob der/die Mitarbeiter:in zum Fälligkeitsdatum des Check-ins im Urlaub (true) war oder nicht (false).
• is_adhoc (boolean). Gibt an, ob der Check-in ad hoc (true) oder geplant (false) war.
• responses (Array). Dieses Array enthält eine Liste von Antworten auf den Check-in. Jede Antwort umfasst:
  • api_id (string). Die Antwort-ID.
  • response_date (string). Das Datum und die Uhrzeit der Antwort.
  • person_name (string). Der vollständige Name des Mitarbeitenden.  
  • person_api_id (string). Die ID des Mitarbeitenden.
  • person_email (string). Die E-Mail-Adresse des Mitarbeitenden.
  • person_department (string). Die Abteilung, der der Mitarbeitende angehört.
  • person_properties (Array). Das Array enthält die Eigenschaften des Mitarbeitenden als String-Parameter im Name-Wert-Paar. Beispielsweise könnte es sich um die Rolle des Mitarbeitenden im Unternehmen handeln.

Beispiel für den Response-Body

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

{
 "api_id": "580:ce417c60-30ca-4e39-967e-b258d496be30",
 "deadline_date": "2025-04-12T00:59:59+01:00",
 "submission_date": "2025-04-11T12:06:00.882601+01:00",
 "überfällig": false,
 "on_vacation": false,
 "is_adhoc": true,
 "responses": [
   {
     "api_id": "580:62a8f61c-88ba-40b6-816a-bf2625db106a",
     "response_date": "2025-04-11T12:06:01.046509+01:00",
     "person_name": "Michael Test",
     "person_api_id": "580:f88ab8b9-4e41-4025-ad77-519006ba855f",
     "person_email": "mtest@test.com",
     "person_department": "Research and Development",
     "person_properties": []
   }
 ]
}