Order-API

Documentation for the Prefill-API of our order form

Url

The TestingTime orderform can be accessed in 3 different languages: English, German & French

English: https://app.testingtime.com/en/order-testusers/{amount-of-users}/{method}
German: https://app.testingtime.com/de/testpersonen-bestellen/{amount-of-users}/{method}
French: https://app.testingtime.com/fr/commande-participants-aux-tests/{amount-of-users}/{method}

Url-Parameters

Parameter	Description	Type	Constraints	Other
amount-of-users	How many users will be recruited	number	3-300
method	The method of the study that will be conducted	string	usertest workshop interview focusgroup survey diary

Query

Many fields on the order form can be prefilled. Here are all the supported parameters. They are all optional.

Query-Parameters (GET)

Parameter	Description	Type	Constraints	Other
min-age	Minimal age of the ordered participants.	number	18-85	Is valid when combined with a max-age
max-age	Maximal age of the ordered participants.	number	18-85	Is valid when combined with a min-age as well. Must be at least 10 years more than the min-age.
gender	Gender mix, if relevant.	string	female male mixed
languages	Languages a test person needs to speak (at least fluently)	string	de fr en it nl	Comma separated if multiple. Max 2.
countries	Countries where the test persons should reside.	string	2 digit ISO-Code - lowercase	Comma separated if multiple. Max 10.
slots	List of all dates when the study will be conducted	number	timestamp	Comma separated numbers
customs	Special criteria for the participants.	string	Maximum length of 140 characters each	Comma separated, max 5.
minutes	Duration of each study	number	10-5000
title	Study title	string	Maximum length of 255 characters
additionalInfo	Additional information for the TestingTime recruiters	string
venue	Where does the study happen	string	IN_HOME IN_HOUSE REMOTE
devices	On what devices do the participants need to be "native" at	string	computer tablet phone watch	Comma separated strings
platform	What OS needs to be installed on the devices	string	apple android windows	Only works if "devices" is provided
contact-firstname	Customer contacts (study conductor) first name	string
contact-lastname	Customer contacts (study conductor) last name	string
contact-email	Customer contacts (study conductor) email	string
contact-phone	Customer contacts (study conductor) phone	string
billing-company	Customer billing address - company name	string
billing-address	Customer billing address - address line 1	string
billing-address2	Customer billing address - address line 2	string
billing-zip	Customer billing address - zip code	string
billing-city	Customer billing address - city name	string
billing-country	Customer billing address - country	string	2 digit ISO-Code - lowercase
billing-instructions	Customer billing reference number	string
billing-email	Customer billing email address	string
location-company	Location of study - company name	string
location-address	Location of study - address line	string
location-zip	Location of study - zip code	string
location-city	Location of study - city name	string
location-company	Location of study - company name	string
location-country	Location of study - country	string	2 digit ISO-Code - lowercase
location-instructions	Location of study - description how to find the location	string		e.g. "ask at the reception for John Meyer"
duration	The amount of time users need to complete a survey or unmoderated user test.	number	10-500	Only works its a survey or an unmoderated user test.
link	The link to the survey or unmoderated user test.	string		Only works its a survey or an unmoderated user test. If link & priority are provided for a method type "user test" it becomes automatically an unmoderated user test.
priority	The priority of the study (Applicable to surveys/ unmoderated user tests)	string	normal express emergency	Only works its a survey or an unmoderated user test.
contact-via	The tool in which the remote study will take place (e.g. Skype, Google Hangouts)	string	Maximum length of 120 characters
contact-via-details	The id of the customer for the given tool	string
expert-exclusion	Plain text description of which experts to exclude (e.g. No UX designers)	string
deadline	Deadline of study (Valid only for surveys/unmoderated user tests)	timestamp
survey-by-redirect	Flag about whether the test person should be redirected to the survey	boolean
frequency	The frequency of entries needed for a diary (e.g. a frequency of 2 means there will be sessions every two days until the deadline)	number
in-home-mode-of-transport	Customer transport means for inhome tests (possible values are CAR / PUBLIC)	string
invite-radius	The radius in which to invite test persons for an inhome study	number
final-survey	Is there a final survey after a diary study or not.	string	true

Hashtag navigation

If you prefill all necessary information, you can choose the step of the order form that is shown at first.

Value	Step	Description
#!/profile	1	Default - Select the users basic profile
#!/setup	2	Setup for your study Not available on method "survey"
#!/survey	2	Link and priority settings for survey Only available on method "survey"
#!/dates	3	Timing of your study Not available on methods "survey" & "diary"
#!/review	3-4	Review all your changes => suggested if all necessary data is prefilled
#!/payment	4-5	If you are sure all is already setup and you want to send the user to the payment step directly