Unterhaltungen über die Perform & Engage 365 API abrufen

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

• Eine Liste von Unterhaltungen abrufen.
• Die Details einer bestimmten Unterhaltung anhand ihrer ID abrufen.

Eine Liste von Unterhaltungen abrufen

GET /api/v2/conversations/

Mit dieser Anfrage können Sie basierend auf den Suchparametern eine Liste von Unterhaltungen abrufen.

Optionale Abfrageparameter

• person_name (String). Der vollständige Name des Mitarbeitenden.
• plan_name (String). Der Name des Unterhaltungstarifs.
• template_name (String). Der Name der Unterhaltungsvorlage.
• status (Zeichenfolge). Der Unterhaltungsstatus: draft, final, deleted oder archived.
• limit (Ganzzahl). Die maximale Anzahl von Unterhaltungen in der Antwort.
• offset (Ganzzahl). Der Anfangsindex, ab dem die Ergebnisse in der Antwort zurückgegeben werden.

Anfragebeispiel

GET /api/v2/conversations/?person_name=Adele%20Vance&plan_name=9-Box%20
Tarif&status=entwurf&template_name=9-Box Vorlage

Parameter des Antworttexts

Der Antworttext enthält:

• count (Ganzzahl). 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 Unterhaltungen. Jede Unterhaltung hat diese Parameter:
  • api_id (String). Die Unterhaltungs-ID. Sie können diese ID verwenden, um weitere Details zur Unterhaltung abzurufen.
  • template_api_id (String). Die ID der Unterhaltungsvorlage. Sie können diese ID verwenden, um weitere Details zur Unterhaltungsvorlage abzurufen.
  • template_name (String). Der Name der Unterhaltungsvorlage.
  • plan_name (String). Der Name des Unterhaltungs-Tarifs.
  • plan_api_id (String). Die ID des Unterhaltungs-Tarifs.
  • stage_name (String). Der Name der aktuellen Phase der Unterhaltung. Wenn die Unterhaltung abgeschlossen ist, ist die Phase Final.
  • stage_api_id (String). Die Phasen-ID.
  • status (String). Der Status der Unterhaltung: draft, final, deleted oder archived.
  • updated_date (string). Datum und Uhrzeit der letzten Aktualisierung der Konversation.
  • completed_date (string). Datum und Uhrzeit des Abschlusses der Konversation.
  • generated_date (string). Datum und Uhrzeit der Generierung der Konversation.
  • person_api_id (string). Die ID des Mitarbeiters.
  • person_name (String). Der vollständige Name des Mitarbeiters.
  • person_email (String). Die E-Mail-Adresse des Mitarbeiters.
  • manager_api_id (string). Die ID des Managers.
  • manager_name (String). Der vollständige Name des Managers.
  • manager_email (String). Die E-Mail-Adresse des Managers.
  • reviewer_api_id und second_reviewer_api_id (string). Die IDs der Prüfenden.
  • reviewer_name und second_reviewer_name (string). Die vollständigen Namen der Prüfenden.
  • reviewer_email und second_reviewer_email (string). Die E-Mail-Adressen der Prüfenden.

Beispiel für den Response-Body

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

{
 "count": 1,
 "next": null,
 "previous": null,
 "results": [
   {
     "api_id": "580:972ba6da-9aa0-4704-aba2-39865339eb3d",
     "template_api_id": "580:44b1729e-a9bf-488c-9ad2-890af66be941",
     "template_name": "9-Box Vorlage",
     "plan_api_id": "580:e3d3071d-f970-4693-872b-e17df6babdf4",
     "plan_name": "9-Box Tarif",
     "stage_name": "Leader Review",
     "stage_api_id": null,
     "status": "entwurf",
     "updated_date": "2021-09-28T10:44:15.945867+01:00",
     "completed_date": null,
     "generated_date": "2021-09-21T12:28:39.712575+01:00",
     "person_api_id": "580:c5b6c1bc-98a4-4e3b-ab17-54fa0c48b2a1",
     "person_name": "Adele Vance",
     "person_email": "adelevance@compafi464.onmicrosoft.com",
     "reviewer_api_id": "580:4c8c3ea5-d584-4ba2-b184-2280d53bbda3",
     "reviewer_name": "Jamie Jones",
     "reviewer_email": "contact+sandboxtemplate@weekly10.net",
     "second_reviewer_api_id": null,
     "second_reviewer_name": null,
     "second_reviewer_email": null,
     "manager_name": "Jamie Jones",
     "manager_email": "contact+sandboxtemplate@weekly10.net",
     "manager_api_id": "580:4c8c3ea5-d584-4ba2-b184-2280d53bbda3"
   }
 ]
}

Rufen Sie die Details einer bestimmten Konversation anhand ihrer ID ab

GET api/v2/conversations/{api_id}/

Nachdem Sie die Konversation-api_id in der Antwort auf die Zurück-Anfrage erhalten haben, können Sie diese ID verwenden, um weitere Informationen zur Konversation abzurufen.

Erforderlicher Pfadparameter

• api_id (Zeichenkette). Die Konversations-ID, die Sie erhalten, indem Sie die GET-Anfrage /api/v2/conversations/ senden.

Beispielanfrage

GET /api/v2/conversations/580%3A972ba6da-9aa0-4704-aba2-39865339eb3d/

Parameter im Response-Body

Zusätzlich zu den gleichen Parametern, die das results-Array in der Antwort auf die GET-Anfrage /api/v2/conversations/ enthält, umfasst die Antwort auf die GET-Anfrage api/v2/conversations/{api_id}/ das data-Array, eine Liste von Konversationselementen.

Beispiel für den Response-Body

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

{
 "api_id": "580:972ba6da-9aa0-4704-aba2-39865339eb3d",
 "template_api_id": "580:44b1729e-a9bf-488c-9ad2-890af66be941",
 "template_name": "9-Box Vorlage",
 "plan_api_id": "580:e3d3071d-f970-4693-872b-e17df6babdf4",
 "plan_name": "9-Box Tarif",
 "stage_name": "Leader Review",
 "stage_api_id": null,
 "status": "entwurf",
 "updated_date": "2021-09-28T10:44:15.945867+01:00",
 "completed_date": null,
 "generated_date": "2021-09-21T12:28:39.712575+01:00",
 "person_api_id": "580:c5b6c1bc-98a4-4e3b-ab17-54fa0c48b2a1",
 "person_name": "Adele Vance",
 "person_email": "adelevance@compafi464.onmicrosoft.com",
 "reviewer_api_id": "580:4c8c3ea5-d584-4ba2-b184-2280d53bbda3",
 "reviewer_name": "Jamie Jones",
 "reviewer_email": "contact+sandboxtemplate@weekly10.net",
 "second_reviewer_api_id": null,
 "second_reviewer_name": null,
 "second_reviewer_email": null,
 "data": [
   {
     "api_id": null,
     "element_title": "Leistung vs Potenzial",
     "element_api_id": "None:3685454d-a3b4-49dc-9539-8f3117a276a6",
     "element_type": "nine_box",
     "value": "2",
     "key": "1542",
     "comment": ""
   }
 ],
 "manager_name": "Jamie Jones",
 "manager_email": "contact+sandboxtemplate@weekly10.net",
 "manager_api_id": "580:4c8c3ea5-d584-4ba2-b184-2280d53bbda3"
}