API

Eine Schnittstelle, viele Möglichkeiten

Metadaten Umfrage

Mit den folgenden Methoden können die Metadaten, sowie weitere Inhalte der Umfrage ausgelesen werden.

Diese Methode bietet Zugriff auf die Metadaten einer Umfrage.

URL

/api/v2/surveys

Methode

GET

Parameter

page, limit

Rückgabe

JSON

Rückgabewerte

Id

int

ID des Datensatzes

CustomerId

int

ID des Kunden

UserId

int

ID des Benutzers, dem die Umfrage zugeordnet ist

FolderId

int

ID des Folders, zu der diese Umfrage gehört

StatusId

Int

Status, in dem sich die Umfrage befindet
0 = nicht aktiviert
1 = aktiviert/beendet
2 = unterbrochen

Archive

int

Umfrage liegt im Archiv
false = Nein
true = Ja

LayoutId

int

Verwendete ID des Layouts

GroupId

int

ID der Benutzergruppe, zu der diese Umfrage gehört

LanguageId

int

ID der Hauptsprache der Umfrage

LanguagesCount

int

Anzahl der verwendeten Sprachen

Pages

int

Anzahl der Seiten innerhalb der Umfrage

Questions

int

Anzahl der Fragen

Visitors

int

Anzahl der Besucher

SurveyCode

str

Code-Bestandteil der Umfrage-URL

SurveyUrl

str

Individueller Text der Umfrage-URL

Title

str

Bezeichnung der Umfrage

Participants

int

Anzahl der Teilnehmer

CreatedAt

date

Datum, an dem die Umfrage angelegt wurde

UpdateAt

date

Datum, an dem die Umfrage zuletzt aktualisiert wurde

StartDate

date

Datum, an dem die Umfrage zuletzt aktiviert wurde

EndDate

date

Datum, an dem die Umfrage beendet wurde

Sprachen

Mit dieser Methode lassen sich alle Sprachen einer Umfrage auflisten.

URL

/api/v2/surveys/languages

Methode

GET

Parameter

surveyid, page, limit

Rückgabe

JSON

Rückgabewerte

Id

int

ID des Datensatzes

SurveyId

int

ID der Umfrage

Name

str

Name der Sprache

CustomName

str

Eigenname der Sprache

Code

str

Code der Sprache, 2 Buchstaben

Seiten

Diese Methode bietet Zugriff auf die Seiten, die für Befragungen angelegt wurden. Eine Besonderheit sind hier die Begrüßungsseite (id: -1) sowie die Abschlussseite (id: -2). Der surveyid Parameter ist bei dieser Methode verpflichtend!

URL

/api/v2/surveys/pages

Methode

GET

Parameter

surveyid (verpflichtend), page, limit

Rückgabe

JSON

Rückgabewerte

Id

int

ID des Datensatzes

SurveyId

int

ID der Umfrage

CustomerId

int

Kunden-ID

Pos

int

Position der Seite in der Umfrage

Questions

int

Anzahl der Fragen pro Seite

Fragen und Elemente

Diese Methode bietet Zugriff auf die Fragen und Elemente innerhalb einer Umfrage. Die Struktur ist streng hierarchisch aufgebaut. Die einzelnen Ebenen der Elemente und den dort vorhandenen Ids entsprechen den Ergebnissen aus /api/v2/results wie folgt:

  1. Ebene: questionid
  2. Ebene: answerid
  3. Ebene: levelid

Der surveyid Parameter ist bei dieser Methode verpflichtend!

URL

/api/v2/surveys/questions

Methode

GET

Parameter

surveyid (verpflichtend), pageid, page, limit

Rückgabe

JSON

Rückgabewerte

Id

int

ID der Frage

CustomerId

int

ID des Kunden

SurveyId

int

ID der Umfrage

QuestionType

int

Fragetyp:
0 = Ja/Nein Frage
1 = Geschlossene Frage
2 = Offene Frage
3 = Bildfrage
4 = Beurteilungsfrage (Matrix)
5 = Doppel-Beurteilungsfrage (Matrix)
6 = Skala / NPS
7 = Ratingfrage
8 = Schieberegler
9 = Rankingfrage
10 = Semantische differenzial Frage
11 = Variable Frage
12 = Gewinnspiel-/Newsletterfrage
13 = Media Upload Frage

Title

translations

Fragetitel der Frage. Null, wenn nicht vorhanden.

QuestionText

translations

Hinweistext der Frage. Null, wenn nicht vorhanden.

ToolTipText

translations

Texte des Tooltips

NotSpecifiedText

translations

Beinhaltet die Texte für „Keine Antwort“

IsMultipleAnswer

bool

Mehrere Antworten möglich (Checkboxen als Antwort)

IsMultipleAnswer2

bool

Mehrere Antworten möglich, bezieht sich auf Doppelmatrix, rechter Teil.

Pos

int

Position der Frage in der Umfrage

PagePos

int

Position der Frage auf der Umfrageseite

ToolTip

int

Aktivierter oder deaktivierter Tooltip. Null, wenn deaktiviert.

AdditionalTextAreaText

obj translations

Beschreibung des zusätzlichen Textfelds. Null, wenn nicht vorhanden.

ElementCollections

arr of elements

Liste der Elemente, aus denen die Frage besteht.

OtherText

translation

Text zum zusätzlichen Textfeld

Element Objekt

id

int

ID des Elements, entspricht je nach Ebene der AnswerId (z. B. Offene Frage) oder LevelId (z. B. Matrix-Frage)

resultType

Wird derzeit nicht verwendet

description

translations

Texte mit Beschreibungen des Elements

additionalDescription

translations

Weitere Texte mit Beschreibungen des elementes, z.B. bei Offener Frage mit Text-elementen vor und hinter den Input-Feldern.

typeName

str

Typ des Elements. Verfügbar sind:

  • Checkbox

  • CheckboxInputCombination

  • CombinedElement

  • DropDownElement

  • Image

  • Input

  • InputCollection

  • IconArray

  • Radio

  • RadioCollection



  • Checkbox

  • CheckboxCollection

  • Ranking

  • Rating

  • Slider

  • Scale

  • TextArea

  • TextareaCollection

  • Upload


Collections bezeichnen Listen der jeweiligen Elemente

Bereit zu starten? Erstellen Sie jetzt großartige Umfragen!