GuidesAPI Reference
API Reference

Run a test

post
https://api.helpfull.com/v1/tests

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.

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.

Body Params
string
length ≤ 500
Defaults to Custom test

Test name, displayed at the results page

string
enum
required

Test type. There are 3 types available at the moment:

  • Images comparison
  • Texts comparison
  • Open ended

Affects question and options fields.

Allowed:
string
required
length ≤ 500

Test question. It will be displayed to participants.

Examples:

  • Which of the following Logos you like the most? (in case of images-comparison type)
  • Our organization is a group of entrepreneurs who live and work remotely around the world. We need helping picking a name, which of the following do you like best and why? (in case of texts-comparison type)
  • How was your day? (in case of open-ended type)
number
25 to 1000
Defaults to 50

Number of participants you want to order. Defaults to 50

options
length between 2 and 8

An array of options to compare. Required when type field is images-comparison or texts-comparison.
Should be an array of images URLs if images-comparison is specified; an array of strings for texts-comparison.

Responses

Updated over 2 years ago

Language
Credentials
Header
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated over 2 years ago