# Helpfull Documentation

> Real-time feedback that helps you understand why, so you can make smarter decisions when it matters most. Get survey feedback online from thousands of people.

Append .md to any documentation page URL to get its markdown version.

## Guides
- [Helpfull public API](https://docs.helpfull.com/docs/getting-started.md)

## API Reference
- [Run a test](https://docs.helpfull.com/reference/run-test.md): We highly recommend to check our Test Builder first in order to get acquainted with the visualized process of Test creation. You can do it inside our application or at https://helpfull.com/create without registration.  Right now we have a simplifed version of a Test Builder at our public API. You may start a Test with only one Question Block of a specific type by chosing a `type` in this request. There are 3 `types` available at the moment: - Images comparison - Texts comparison - Open ended  If you need a more deep Test configurations or have any questions regarding the process please feel free to [contact us](https://helpfull.com/contact-us).  Please note that you will be charged for the missing credits needed to run a test. All your discounts will be applied. Example: you have `20` credits, the Test cost is `50` credits -> you will be charged for `50 - 20 = 30` missing credits. You may get acquainted with our pricing inside our application or at https://helpfull.com/calculator.
- [Retrieve a test](https://docs.helpfull.com/reference/get-test.md): Retrieves a Test with the given ID.  If you want to update the number of currently submitted responses in real-time, you would probably be interested in `numberOfResponses` field.  Please note that we usually order slightly more responses than ordered, so for monitoring the test completion status please check the `status` field rather than `numberOfResponses`, which could be a bit higher than `numberOfParticipants` ordered (f.e. `202/200`).
- [Retrieve all test comments](https://docs.helpfull.com/reference/get-comments.md): Retrieve a list of all participants Comments at a Test