Antworten auflisten

Name: SentiSnap
Author: SentiSnap s.r.o.

Rufen Sie Antworten einer Umfrage mit optionaler Filterung ab.

GET

https://api.sentisnap.com/v1/surveys/{surveyId}/responses

Authentifizierung

Erfordert einen API-Schlüssel mit der Berechtigung responses:read.

Pfad-Parameter

Parameter	Typ	Pflicht	Beschreibung
`surveyId`	string	Ja	Survey UUID

Query-Parameter

Parameter	Typ	Pflicht	Beschreibung
`page`	integer	Nein	Page number (default: 1)
`per_page`	integer	Nein	Number per page (default: 50, max: 100)
`filter[submittedAt][gte]`	string	Nein	Filter by date (ISO 8601)
`filter[submittedAt][lte]`	string	Nein	Filter by date (ISO 8601)

Antwort

{
  "data": [
    {
      "id": "019def45-6789-0abc-def0-123456789abc",
      "respondent_id": "resp_abc123",
      "status": "completed",
      "data": {
        "question_uuid_1": "Very satisfied",
        "question_uuid_2": [
          "Feature A",
          "Feature C"
        ],
        "question_uuid_3": "The product is excellent and easy to use."
      },
      "metadata": {
        "source": "email",
        "language": "en",
        "time_spent_seconds": 245
      },
      "started_at": "2024-01-20T14:20:00Z",
      "submitted_at": "2024-01-20T14:24:05Z",
      "created_at": "2024-01-20T14:20:00Z"
    }
  ],
  "meta": {
    "page": 1,
    "per_page": 50,
    "total": 1250,
    "total_pages": 25
  },
  "links": {
    "self": "/v1/surveys/019abc.../responses?page=1",
    "next": "/v1/surveys/019abc.../responses?page=2"
  }
}

Antwortfelder

Feld	Typ	Beschreibung
`id`	string	Eindeutiger Antwort-Identifikator
`respondent_id`	string	Anonymer Befragten-Identifikator
`status`	string	Antwortstatus: started, completed
`data`	object	Antworten auf Fragen, nach Frage-ID zugeordnet
`metadata`	object	Zusätzliche Antwort-Metadaten
`started_at`	string	Wann der Befragte begonnen hat
`submitted_at`	string	Wann die Antwort abgesendet wurde

Beispiel

# Get responses from the last 7 days
curl -X GET "https://public-api.sentisnap.com/v1/surveys/019abc.../responses?filter[submittedAt][gte]=2024-01-13T00:00:00Z" \
  -H "Authorization: Bearer sk_live_..."

Fehler

Code	Beschreibung
`401`	Ungültiger API-Schlüssel
`403`	Unzureichende Berechtigung (erfordert `responses:read`)
`404`	Umfrage nicht gefunden