surveys

GET `/v1/surveys/active`

The surveys this organisation may currently be shown.

Xác thực

Gửi khóa API dưới dạng mã thông báo bearer. Khóa này phải có quyền org.read; khóa không có quyền này sẽ bị từ chối với mã lỗi 403, không phải 404.

Nơi điền id tổ chức của bạn

Điểm cuối này nhận org_id làm tham số truy vấn. Hãy bỏ trống để áp dụng cho toàn bộ cây thuê của bạn; hoặc truyền giá trị vào để thu hẹp phạm vi gọi về một tổ chức duy nhất.

Mã tổ chức của bạn nằm ở màn hình khóa API trong bảng điều khiển, ngay bên cạnh khóa đó. Đây là cùng một mã trong mọi lệnh gọi mà bạn thực hiện.

Dùng thử

Thay thế bất kỳ nội dung nào trong ngoعل (angle brackets) bằng giá trị của riêng bạn và trình giữ chỗ key bằng một key từ trang tổng quan của bạn.

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

Đã đăng nhập? Bảng điều khiển API trong trang quản lý của bạn sẽ tự điền ID tổ chức thực tế và khóa của riêng bạn, sau đó chạy yêu cầu đối với API trực tiếp để bạn có thể xem phản hồi thực tế. Mở điểm cuối này trong bảng điều khiển API

Chi tiết

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

Tham số

Tên	Loại	Bắt buộc	Nội dung này là gì
`org_id (query)`	`string`	Không	—
`distinct_id (query)`	`string`	Không	The browser's analytics distinct id, so the join resolves.

Phản hồi

Tên	Loại	Bắt buộc	Nội dung này là gì
`available`	`boolean`	Có	—
`reason`	`string<, unconfigured, unreachable, refused, not_found, malformed>`	Có	—
`surveys`	`Survey[]`	Có	—

Các lỗi điểm cuối này có thể trả về

401 · 403