surveys

POST `/v1/surveys/{survey_id}/responses`

Record one person's answers to one survey.

Authentification

Envoyez une clé API en tant que jeton du porteur. La clé doit posséder l'autorisation org.read ; une clé qui ne l'a pas est refusée avec le code 403, et non 404.

Où insérer l'ID de votre organisation

Cet endpoint prend org_id comme champ dans le corps JSON.

L'identifiant de votre organisation se trouve sur l'écran des clés API de votre tableau de bord, à côté de la clé elle-même. Il s'agit du même identifiant pour chaque appel que vous effectuez.

Essayer

Remplacez tout ce qui se trouve entre crochets par vos propres valeurs, et le espace réservé à la clé par une clé de votre tableau de bord.

curl -X POST https://api.zinndigital.com/v1/surveys/{survey_id}/responses \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "answers": <SurveyAnswer[]> }'

Connecté ? La console d'API de votre tableau de bord saisit votre véritable ID d'organisation ainsi que votre propre clé, et exécute la requête sur l'API de production afin que vous puissiez voir la réponse réelle. Ouvrir ce point de terminaison dans la console API

Détails

Stored in our own organisation-scoped table FIRST and unconditionally, then mirrored to the behavioural backend so the analytics join resolves. The two copies have opposite error policies deliberately: losing the customer's answer is unacceptable, losing the vendor's copy of an answer we already hold costs a join. ⛔ The survey is re-fetched and re-checked against the store — a client sends an id, and a client is a thing a person can edit. Answering an archived or stopped survey is refused. A SECOND answer from the same person returns `200` with `duplicate: true` rather than a conflict: the unique constraint exists to stop a doubled count, and the commonest way it fires is a retry after a dropped connection. Requires `org.read`.

Paramètres

Nom	Type	Obligatoire	Qu'est-ce que c'est
`survey_id (path)`	`string`	Oui	—

Corps de la requête

Nom	Type	Obligatoire	Qu'est-ce que c'est
`org_id`	`string`	Non	—
`distinct_id`	`string`	Non	The browser's analytics distinct id. ⛔ Without it the mirrored event attaches to a person who does not exist, and the join looks healthy and is empty.
`path`	`string`	Non	—
`answers`	`SurveyAnswer[]`	Oui	—

Réponse

Nom	Type	Obligatoire	Qu'est-ce que c'est
`recorded`	`boolean`	Oui	—
`duplicate`	`boolean`	Oui	True when this person had already answered. ⛔ Reported as a success, not a conflict — the commonest cause is a retry after a dropped connection, and telling the customer it fail…
`id`	`string`	Non	—

Erreurs que cet point de terminaison peut renvoyer

401 · 403 · 404 · 422