SurveyLabs offers API access to automate business processes, such as sending a questionnaire each time a particular event occurs.
API access is currently early beta.
Inquiries regarding API access can be made to email@example.com.
Request / Response Format
SurveyLabs API uses HTTPS requests with JSON parameters. API response is also in JSON format.
API access is validated with Access Token. Your own Access Token can be generated under your account (top right corner) -> API.
Generate your Access Token with the following steps:
1) Create an account at SurveyLabs.
2) Login to you account
3) Click on the top right account icon
4) Navigate dropdown menu to "Account"
5) Go to submenu "API"
6) Create Access Token
Our API uses standard HTTP status codes like 2xx for success and 4xx for errors. Following table displays HTTP status codes.
|200 OK||Request is successful.|
|201 Created||New resources have been successfully created.|
|202 Accepted||Request accepted but it is queued or processing.|
|400 Bad Request||Request has missing required parameters.|
|401 Unauthorized||Incorrect Token or missing token.|
|403 Forbidden|| Access denied for the requested resource.|
|404 Not Found||The requested resource does not exist.|
|429 Too Many Requests||Api request limit exceeded.|
|500 Internal Server Error||Something went wrong in at server.|
For search results where the number of records exceeds our default max records, Pagination is used.
Pagination is used by specifying maxResult
(records per page) and pageNo (page number). Our default max records are currently 50 records.
|maxResult||Max records pr. page||Integer|
Sent as parameters to GET
Objects are used to identify items in the questionnaire. It can be the questionnaire itself, collectors, reports, etc.
|survey_id||Used to identity a specific survey|
|collector_id||Collector_id attached to a survey. Collectors can be: email, website, QR code etc.|
|list_id||list_id attached to a email collectors only. List contains respondents.|