> For the complete documentation index, see [llms.txt](https://synap.ac/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://synap.ac/docs/platform/library/surveys.md).

# Surveys

Surveys collect structured responses without requiring the assessment structure of a quiz. A survey can contain multiple pages and a mixture of question types.

{% hint style="info" %}
**Location:** Library → Create or upload → Survey
{% endhint %}

### When to use a survey

Surveys are suitable for feedback, confidence checks, declarations and other response collection where a score is not the main outcome.

Surveys are reusable Library items. Add them to a **Collection** or **Course** alongside other learning content, then deliver that structure directly or through an assignment. This makes surveys useful before, during or after a learning activity.

Examples include:

* a pre-course needs analysis;
* a post-course evaluation;
* an acknowledgement or declaration;
* a confidence rating between course sections;
* a form that collects supporting information or a file.

### Build a survey

The survey builder is divided into three areas:

| Area               | Purpose                                                                  |
| ------------------ | ------------------------------------------------------------------------ |
| **Survey details** | Set the title, description, ownership and other identifying information. |
| **Questions**      | Create pages and add, edit or reorder survey items.                      |
| **Access**         | Control who can access and manage the survey.                            |

Use pages to divide a longer survey into manageable steps. Within **Questions**, add items to a page and drag them into the required order.

![The Survey builder showing pages and several survey item types](https://files.gitbook.com/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FWXE6hvHQFtER1a1Dm3l5%2Fuploads%2FRhAHUDYs7akTDB3KPjGg%2Fsurvey-builder.png?alt=media\&token=e74b4a49-10f3-4879-9c92-5cc908c8846b)

### Survey item types

Select **Add question**, then choose the response format that matches the information you need.

| Item type           | User response                                               | Good for                                                  |
| ------------------- | ----------------------------------------------------------- | --------------------------------------------------------- |
| **Short answer**    | A compact, single-line text response.                       | Names, identifiers or concise comments.                   |
| **Long answer**     | A larger text response for several sentences or paragraphs. | Detailed feedback and explanations.                       |
| **Date**            | A date selected using a date input.                         | Start dates, review dates or declarations tied to a date. |
| **Sliding scale**   | A position selected on a Likert-style scale.                | Confidence, satisfaction and agreement ratings.           |
| **Multiple choice** | One option selected from a list.                            | Mutually exclusive answers.                               |
| **Checkboxes**      | One or more options selected from a list.                   | Questions where several answers may apply.                |
| **Upload**          | A file supplied by the user.                                | Evidence, completed forms or supporting documents.        |

![Editing a multiple-choice survey item, including the rich-text prompt, options and Required setting](https://files.gitbook.com/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FWXE6hvHQFtER1a1Dm3l5%2Fuploads%2FXMBJmky3dt76xUytXXtk%2Fsurvey-question-editor.png?alt=media\&token=004916f0-8686-4ccc-badb-e465f078c94b)

For **Sliding scale**, **Multiple choice** and **Checkboxes**, define the available options. A survey item supports between 2 and 10 options. Keep option labels distinct and use a consistent scale direction.

{% hint style="warning" %}
Use **Multiple choice** when a user must select one answer and **Checkboxes** when they may select several. The difference should also be clear in the question wording.
{% endhint %}

### Write and configure a question

The question prompt supports formatted text, including headings, emphasis, links, lists, tables and images. This can be useful when a question needs context, but keep the response itself unambiguous.

Each item can be set as **Required**. A user cannot complete the survey without answering required items, so reserve this setting for information you genuinely need.

Before distributing a survey:

1. Check the page and question order.
2. Confirm that required questions are intentional.
3. Preview the survey at the size users are likely to see it.
4. Confirm who should have access.

### Results

Survey responses can be reviewed through the reporting surfaces available to your portal. Decide whether responses are intended to be identifiable and communicate that expectation to participants before they begin.

{% hint style="info" %}
Keep required questions purposeful. Asking only for data you plan to use usually improves completion and response quality.
{% endhint %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://synap.ac/docs/platform/library/surveys.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.