surveys

GET `/v1/surveys/active`

The surveys this organisation may currently be shown.

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 point de terminaison prend org_id comme paramètre de requête. Omettez-le et l'appel couvrira l'ensemble de votre sous-arbre de location ; envoyez-le pour restreindre l'appel à une seule organisation.

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 GET https://api.zinndigital.com/v1/surveys/active \
  -H "Authorization: Bearer zdk_live_…"

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

Every decision ABOUT the customer is applied here, server-side, before a survey crosses the wire — good standing, the per-organisation kill switch, and archived or stopped surveys. The client is left with exactly the three things only it can know: which route it is on, whether this person has seen a survey recently, and the sampling die roll. ⛔ `available` is a first-class part of the answer. A survey store that is unconfigured, rate-limited or unreachable is NOT the same fact as "you have no surveys", and `surveys: []` on its own would tell the app every survey had been archived. On `available: false` the client keeps its previous answer. Requires `org.read`.

Paramètres

Nom	Type	Obligatoire	Qu'est-ce que c'est
`org_id (query)`	`string`	Non	—
`distinct_id (query)`	`string`	Non	The browser's analytics distinct id, so the join resolves.

Réponse

Nom	Type	Obligatoire	Qu'est-ce que c'est
`available`	`boolean`	Oui	—
`reason`	`string<, unconfigured, unreachable, refused, not_found, malformed>`	Oui	—
`surveys`	`Survey[]`	Oui	—

Erreurs que cet point de terminaison peut renvoyer

401 · 403