Customer Experience
Employee Experience
Brand Experience
Core XM
Design XM

Qualtrics-API-Dokumentation verwenden

Informationen zur API-Dokumentation

Auf unserer Qualtrics-API-Dokumentationsseite finden Sie alle derzeit verfügbaren Dokumentationen.

Auf dieser Seite erfahren Sie, wie Sie in unserer Dokumentation navigieren können. Sie erfahren, was die einzelnen Abschnitte besprechen und was verfügbar ist.

Übersicht

In der API-Übersicht können Sie Informationen zur Qualtrics-API im Allgemeinen sowie Informationen zur Paginierung sehen (d.h. wenn Sie eine Listen-Kontaktanfrage ausführen und mehr als 100 Kontakte haben, wird das Ergebnis paginiert und eine nextPage-URL bereitgestellt, um die nächsten 100 zu erhalten – dies gilt für alle Sammlungsanfragen).

Qualtrics-Server auf Erlaubtliste setzen

Siehe Qualtrics-Server auf Erlaubtliste setzen.

Basis-URL und Rechenzentrums-IDs

In diesem Unterabschnitt wird gezeigt, wie Sie die Rechenzentrums-ID finden, die Sie in die Basis-URL für Ihre API-Anforderungen aufnehmen müssen.

Finden Ihrer Qualtrics-IDs

Dieser Unterabschnitt zeigt Ihnen, wo Sie die verschiedenen IDs finden, die Sie beim Ausführen von API-Anforderungen benötigen. Informationen zu IDs, die in diesem Abschnitt nicht verfügbar sind, finden Sie unter Suchen von Qualtrics-IDs durch Prüfen des Elements.

Authentifizierung

Im Unterabschnitt Authentifizierung werden die Informationen beschrieben, die zur Authentifizierung Ihrer Anforderungen benötigt werden, sowie Vorschläge zum Schutz Ihres API-Tokens. Weitere Informationen zum Authentifizierungsprozess finden Sie unter Generieren eines API-Tokens.

Parameter

Der Unterabschnitt Parameter umfasst die verschiedenen Methoden für die Parameterübergabe, abhängig von der verwendeten HTTP-Methode (GET, POST, PUT oder DELETE).

Antworten

Der Unterabschnitt Antworten enthält Beispiele für die verschiedenen HTTP-Antwortcodes, die zurückgegeben werden können, wenn Sie eine Anforderung ausführen, sowie die möglichen Gründe für jeden Antwortcode. Unsere API gibt Antworten immer in JSON zurück, außer im Fall der Antwortexportanforderung, bei der die Datei in einem unserer verfügbaren Formate zurückgegeben werden kann.

Tipp: Wenn Antworten oder Upgrade von vorherigen Versionen nicht als Optionen in der Dokumentation angezeigt werden, stellen Sie sicher, dass Sie Alle anzeigen 7 unten in der Liste des API-Abschnitts auswählen.

Verwenden der Qualtrics-APIs

Dieser Abschnitt der Dokumentation enthält Code-Snippets in Python und Java, die Sie bei der Entwicklung von Workflows zur Verwaltung von Umfragen und Benutzern und zum Abrufen von Umfrageergebnissen unterstützen.

Warnung: Kundenspezifische Coding-Funktionen werden unverändert bereitgestellt und erfordern möglicherweise Programmierkenntnisse für die Implementierung. Unser Support bietet keine Hilfe oder Beratung im Zusammenhang mit benutzerdefinierter Codeerstellung. Stattdessen können Sie sich gerne in unserer Benutzer-Community erkundigen. Wenn Sie mehr über unsere Services für benutzerdefinierte Codeerstellung erfahren möchten, wenden Sie sich an Ihren Account Executive bei Qualtrics.

Referenz

Der Abschnitt Referenz enthält wichtige Informationen zu akzeptablen Datums- und Zeitformaten, Sprachcodes, Anforderungslimits und Details zu Ereignisabonnements. Mit Ereignisabonnements können Sie Benachrichtigungen an eine Publikations-URL senden, sobald ein Ereignis eintritt (z.B. wenn eine Antwort aufgezeichnet wird).

Anfragen

Um die Dokumentation zu organisieren und Benutzern zu helfen, die gesuchten API-Anforderungen zu finden, werden die Anforderungen wie folgt kategorisiert:

Organisationen
Abteilungen
Gruppen
Benutzer
Umfragen
Exportieren von Umfrageantworten
Antworten
Antwortimporte
Nachrichtenbibliothek
Grafikbibliothek
Verteilungen
Kontakte der Insights-Plattform
Ereignisabonnements
XM-Directory (Target Audience)

Anfrageparameter und -optionen

Jede API-Anforderung hat einen Namen, eine kurze Beschreibung, eine Tabelle, die mögliche Parameter, die Antwort, eine Beispielanforderung in cURL und den Assistenten „Try It Out“ auflistet. Wenn Sie wissen, wie Sie diese Informationen verwenden, können Sie Ihre Arbeit optimieren.

Name, Beschreibung und URL

Die ersten drei Dinge, die für eine API-Anforderung aufgeführt sind, sind das HTTP-Verb, der Name der API-Anforderung und eine kurze Beschreibung der Anforderung.

Die im Request (oder “Definition”) verwendete URL wird neben dem HTTP-Verb aufgeführt.

Beachten Sie die in den URLs verwendete Drilldown-Struktur. Zum Beispiel:

Die Anforderung Mailinglisten auflisten verwendet die folgende URL: https://yourdatacenterid.qualtrics.com/API/v3/mailinglists
Sie können dann eine mit dieser Anfrage zurückgegebene ID verwenden, um eine bestimmte Mailingliste zu erhalten, indem Sie die ID an das Ende der URL anhängen: https://yourdatacenterid.qualtrics.com/API/v3/mailinglists/:mailingListId
Um die Kontakte in dieser Mailingliste aufzulisten, fügen Sie Kontakte zum Ende hinzu: https://yourdatacenterid.qualtrics.com/API/v3/mailinglists/:mailingListId/contacts
Um einen bestimmten Kontakt zu erhalten, können Sie dann eine contactId verwenden, die in der vorherigen Anfrage zurückgegeben wurde: https://yourdatacenterid.qualtrics.com/API/v3/mailinglists/:mailingListId/contacts/:contactId

Liste der Body-Parameter

Für jede API-Anforderung sehen Sie eine Tabelle mit allen möglichen Textparametern, die verwendet werden können (einige sind optional, andere sind erforderlich). Diese Tabelle enthält folgende Informationen:

Name jedes Parameters
Die akzeptierten Formate für jeden Parameter
ob der Parameter erforderlich ist
Eine kurze Beschreibung des Parameters

Achtung: Bei allen Parameternamen und -werten wird zwischen Groß- und Kleinschreibung unterschieden.

Beispiel anfordern

Das in der Dokumentation angegebene Antragsbeispiel zeigt Ihnen, wie Sie die Anforderung in cURL formatieren. Diese Anforderungen enthalten die Root-URL und alle erforderlichen Parameter aus der Parametertabelle.

Tipp: Da die IDs nur Beispiele und keine echten IDs sind, funktionieren die Anfragen in den Beispielen nicht wirklich, sondern Sie können sie einfach durch IDs aus Ihrem eigenen Konto ersetzen.

Antwortbeispiel

Dieser Abschnitt enthält ein Beispiel dafür, was Sie erwarten können, wenn Ihre API-Anforderung erfolgreich ist. Wenn Sie beispielsweise die API-Anforderung Benutzer anlegen verwenden, ist Ihre Antwort die Benutzer-ID des neu angelegten Benutzers.

Abschließen von API-Anforderungen auf der API-Site

Mit unserer API-Dokumentation können Sie einen API-Request schnell und einfach ausführen. (Beachten Sie, dass die meisten API-Anforderungen Qualtrics-IDs erfordern.)

Achtung: Seien Sie beim Testen von APIs vorsichtig. Wenn Sie die mindestens erforderlichen Informationen zum Ausführen eines API-Aufrufs eingeben, schließt dieses modale Fenster Ihre API-Anforderung ab. Erforderliche Felder variieren je nach API-Aufruf und werden auf der Seite des Aufrufs aufgeführt.

Wählen Sie zwischen API-Schlüssel und OAuth 2.0.
Geben Sie das API-Token Ihres Kontos in das Feld API-Token ein. (Oder die entsprechenden OAuth-2.0-Informationen, wenn Sie OAuth 2.0 wählen.)
Geben Sie ggf. weitere Parameter ein.
Klicken Sie auf Benutzer, um einen Server auszuwählen, auf dem getestet werden soll. Für den genauesten Test möchten Sie, dass dieser mit dem Rechenzentrum Ihres Kontos übereinstimmt.
Wählen Sie API-Anforderung senden, um den API-Aufruf zu testen.

Tipp: Um zu erfahren, welche Werte für die einzelnen Parameter akzeptabel sind, lesen Sie die Tabelle der Parameter für die Anforderung. Beachten Sie auch das cURL-Beispiel in der Dokumentation.

Sobald Sie die erforderlichen Werte für Ihre Anfrage eingegeben haben, wird die Ausgabe des Anrufs unter „Antwort“ angezeigt.

Achtung: Einige Requests funktionieren nicht mit dieser Testfunktion. Dies wird auf der Seite für die Anforderung angezeigt.

Viele Seiten dieses Portals wurden mithilfe maschineller Übersetzung aus dem Englischen übersetzt. Obwohl wir bei Qualtrics die bestmögliche maschinelle Übersetzung ausgewählt haben, um ein möglichst gutes Ergebnis zu bieten, ist maschinelle Übersetzung nie perfekt. Der englische Originaltext gilt als offizielle Version. Abweichungen zwischen dem englischen Originaltext und den maschinellen Übersetzungen sind nicht rechtlich bindend.