x-cpod-domain: surveys
Surveys
Survey definitions, individual responses, and aggregate analytics for feedback and engagement measurement.
Try in explorer
client.surveys.surveys · client.surveys.responses · client.surveys.analyticsSurvey
A survey definition with questions and configuration.
REST path
/api/v1/surveys/surveysOperations
listgetcreateupdatedeleteSDK
// list — returns only your records; add filters/search:
await client.surveys.surveys.surveys.list()
// create:
await client.surveys.surveys.surveys.create({
title: "example title",
id: "rec_01HXEXAMPLE",
description: "example description",
status: "draft",
created_at: "2026-01-01T00:00:00Z",
})| Field | Type | Description |
|---|---|---|
| id | uuid | — |
| title* | string | — |
| description | string | — |
| status | enum | —draftactiveclosedarchived |
| questions | json | — |
| created_at | date-time | — |
SurveyResponse
An individual response to a survey.
REST path
/api/v1/surveys/responsesOperations
listgetcreatedeleteSDK
// list — returns only your records; add filters/search:
await client.surveys.surveys.responses.list()
// create:
await client.surveys.surveys.responses.create({
id: "rec_01HXEXAMPLE",
survey_id: "survey_01HXEXAMPLE",
respondent_id: "rec_01HXEXAMPLE",
submitted_at: "2026-01-01T00:00:00Z",
})| Field | Type | Description |
|---|---|---|
| id | uuid | — |
| survey_id | uuid→Survey | — |
| respondent_id | uuid | — |
| answers | json | — |
| submitted_at | date-time | — |
SurveyAnalytics
Aggregate analytics and benchmarks for a survey.
REST path
/api/v1/surveys/analyticsOperations
listgetSDK
// list — returns only your records; add filters/search:
await client.surveys.surveys.analytics.list()| Field | Type | Description |
|---|---|---|
| id | uuid | — |
| survey_id | uuid→Survey | — |
| response_count | integer | — |
| completion_rate | number | — |
| period | string | — |