surveys
GET /v1/surveys/active
The surveys this organisation may currently be shown.
Аутентификација
Пошаљите API кључ као bearer токен. Кључ мора имати дозволу org.read; кључ без ње се одбија уз 403, а не 404.
Где се уноси ID ваше организације
Ова крајња тачка прихвата org_id као параметар упита. Изоставите га и позив ће обухватити цело подстабло вашег закупа; пошаљите га да бисте сузили позив на једну организацију.
Идентификатор ваше организације се налази на екрану са API кључевима на вашој контролној табли, поред самог кључа. То је исти идентификатор у сваком позиву који упутите.
Испробајте
Замените све што је у угластим заградама сопственим вредностима, а чувар места кључа кључем са своје контролне табле.
curl -X GET https://api.zinndigital.com/v1/surveys/active \
-H "Authorization: Bearer zdk_live_…"Пријављени сте? API конзола на вашој контролној табли попуњава ваш прави id организације и ваш сопствени кључ, и покреће захтев према живом API-ју како бисте могли да видите стварни одговор. Отворите ову крајњу тачку у API конзоли
Детаљи
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.
Параметри
| Назив | Тип | Обавезно | Шта је ово |
|---|---|---|---|
org_id (query) | string | Не | — |
distinct_id (query) | string | Не | The browser's analytics distinct id, so the join resolves. |
Одговор
| Назив | Тип | Обавезно | Шта је ово |
|---|---|---|---|
available | boolean | Да | — |
reason | string<, unconfigured, unreachable, refused, not_found, malformed> | Да | — |
surveys | Survey[] | Да | — |
Грешке које ова крајња тачка може вратити
401 · 403