surveys

GET `/v1/surveys/active`

The surveys this organisation may currently be shown.

Autenticación

Envía una clave de API como token de portador. La clave debe tener el permiso org.read; una clave que no lo tenga se rechazará con un código 403, no 404.

Donde va el ID de tu organización

Este endpoint acepta org_id como parámetro de consulta. Omítelo y la llamada abarcará todo tu subárbol de inquilinos; envíalo para acotar la llamada a una sola organización.

El id de tu organización se encuentra en la pantalla de claves de API en tu panel de control, junto a la propia clave. Es el mismo id en cada llamada que realices.

Pruébalo

Reemplaza cualquier elemento entre corchetes angulares por tus propios valores, y el marcador de posición key con una clave de tu panel de control.

curl -X GET https://api.zinndigital.com/v1/surveys/active \
  -H "Authorization: Bearer zdk_live_…"

¿Has iniciado sesión? La consola de la API en tu panel de control rellena el ID de tu organización real y tu propia clave, y ejecuta la solicitud contra la API en vivo para que puedas ver la respuesta real. Abre este endpoint en la consola de la API

Detalles

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`.

Parámetros

Nombre	Tipo	Obligatorio	¿Qué es esto?
`org_id (query)`	`string`	No	—
`distinct_id (query)`	`string`	No	The browser's analytics distinct id, so the join resolves.

Respuesta

Nombre	Tipo	Obligatorio	¿Qué es esto?
`available`	`boolean`	Sí	—
`reason`	`string<, unconfigured, unreachable, refused, not_found, malformed>`	Sí	—
`surveys`	`Survey[]`	Sí	—

Errores que este endpoint puede devolver

401 · 403