surveys
GET /v1/surveys/active
The surveys this organisation may currently be shown.
Автентифікація
Надішліть ключ API як маркер носія (bearer token). Ключ повинен мати дозвіл org.read; ключ без нього відхиляється з кодом 403, а не 404.
Де вказується ідентифікатор вашої організації
Цей ендпоїнт приймає org_id як параметр запиту. Залиште його порожнім, і виклик охопить увесь ваше дерево орендарів; надішліть його, щоб звузити виклик до однієї організації.
Ідентифікатор вашої організації знаходиться на екрані API-ключів у вашій панелі керування, поруч із самим ключем. Це той самий ідентифікатор у кожному вашому запиті.
Спробувати
Замініть усе в кутових дужках власними значеннями, а заповнювач ключа — ключем із вашої панелі керування.
curl -X GET https://api.zinndigital.com/v1/surveys/active \
-H "Authorization: Bearer zdk_live_…"Увійшли в систему? Консоль API у вашій панелі керування автоматично підставляє ваш реальний ідентифікатор організації та ваш власний ключ, а також виконує запит до робочого 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