surveys

GET `/v1/surveys/active`

The surveys this organisation may currently be shown.

Autentizace

Zašlete API klíč jako nosný token (bearer token). Klíč musí mít oprávnění org.read; klíč bez něj je odmítnut s kódem 403, nikoli 404.

Sem patří ID vaší organizace

Tento koncový bod přijímá org_id jako parametr dotazu. Pokud ho vynecháte, volání pokryje celý podstrom vašeho nájemce; jeho odesláním volání zúžíte na jednu organizaci.

ID vaší organizace najdete na obrazovce API klíčů ve vašem přehledu, hned vedle samotného klíče. Je to stále stejné ID v každém volání, které provedete.

Vyzvednout

Nahraďte cokoli v závorkách vlastními hodnotami a zástupný symbol klíče klíčem z vašeho řídicího panelu.

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

Přihlášeni? Konzole API ve vašem dashboardu automaticky doplní vaše skutečné ID organizace i váš vlastní klíč a odešle požadavek na živé API, abyste viděli reálnou odpověď. Otevřete tento koncový bod v konzoli API

Podrobnosti

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

Parametry

Název	Typ	Požadováno	Co to je
`org_id (query)`	`string`	Ne	—
`distinct_id (query)`	`string`	Ne	The browser's analytics distinct id, so the join resolves.

Odpověď

Název	Typ	Požadováno	Co to je
`available`	`boolean`	Ano	—
`reason`	`string<, unconfigured, unreachable, refused, not_found, malformed>`	Ano	—
`surveys`	`Survey[]`	Ano	—

Chyby, které může tento koncový bod vrátit

401 · 403