surveys

GET `/v1/surveys/active`

The surveys this organisation may currently be shown.

Autentifikacija

Pošaljite API ključ kao nosivi token. Ključ mora imati dozvolu org.read; ključ bez nje se odbija s kodom 403, a ne 404.

Gdje dolazi ID vaše organizacije

Ova krajnja točka uzima org_id kao parametar upita. Izostavite ga i poziv obuhvaćett cijelo stablo vašeg najma; pošaljite ga kako biste suzili poziv na jednu organizaciju.

ID vaše organizacije nalazi se na zaslonu API ključeva u vašoj nadzornoj ploči, pored samog ključa. To je isti ID u svakom pozivu koji uputite.

Isprobajte

Zamijenite sve unutar šiljastih zagrada svojim vlastitim vrijednostima, a rezervirano mjesto za ključ s ključem iz vaše nadzorne ploče.

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

Prijavljeni ste? API konzola na vašoj nadzornoj ploči automatski unosi stvarni ID vaše organizacije i vaš vlastiti ključ te šalje zahtjev prema aktivnom API-ju kako biste mogli vidjeti stvarni odgovor. Otvori ovu krajnju točku u API konzoli

Pojedinosti

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

Parametri

Naziv	Vrsta	Obavezno	Što je to
`org_id (query)`	`string`	Ne	—
`distinct_id (query)`	`string`	Ne	The browser's analytics distinct id, so the join resolves.

Odgovor

Naziv	Vrsta	Obavezno	Što je to
`available`	`boolean`	Da	—
`reason`	`string<, unconfigured, unreachable, refused, not_found, malformed>`	Da	—
`surveys`	`Survey[]`	Da	—

Pogreške koje ova krajnja točka može vratiti

401 · 403