API
- Home
- /
- API
Function | Description | Parameters | Sample Input | Sample Output |
---|---|---|---|---|
getlistofsurv-eybykey | Fetch all active surveys. |
api_key: API Key given in your Manage Account section email: Primary email address. |
{"api_key":"YOUR APIKEY", "email":"REGISTEREDEMAIL ID"} |
{"status":"Success","data":[{"creationdate":"","lastupdate":" ","uniquecode":"","customer_information_fieldsID":"","screen_type":"Single","contact_form_name":"","status":"","title":"","font":"","version":"","survey
logic":"","welcome_type":"", "welcome_type_id":"", "welcome_image":"", "welcome_text":"","message_type":"","completion_text":""}]}
|
allresult | Allows you to fetch all responses |
api_key: API Key given in your Manage Account section email: Primary email address. uniquecode: get unique code from API function getListOfSurveyByKey |
{
""api_key"":""YOUR API KEY"",
""email"":""REGISTERED EMAIL ID"",
""uniquecode"":""SURVEY UNIQUE CODE""
} |
{"status":"Success","data":{"questionnaire":[{"questionnaireID":"","companyID":"","title":"","version":"1.1","survey_logic":"","response_count":""}],"question":[{"questionID":"","questionnaireID":"","question_type":"","question":"","spporting_text":"","option1":"","option2":"","option3":"","option4":"","option5":"","option6":"","option7":"","option8":"","option9":"","required":"N","max_length":"0","validation_option":"","id":""}],"customer_answers":[{"respondant":{"customerID":"","uniquecode":"","answer_via":"","device_uuid":"","timezone":"","survey_start_time":"","survey_end_time":"","time_stamp":"","creationdate":"","agentID":"","questionnaireID":"","area":null,"longitude":"","latitude":"","city":"","state":"","country":"","update_status":""},"answer":[{"answerID":"","other":"0","skiped":"","uniquecode":"","creationdate":"","lastupdate":"","question_submit_time":"","customerID":"","questionnaireID":"","questionID":"","answer_text":""}],"customerDetails":[{"feilds":"Name","data":""},{"feilds":"Email","data":""},{"feilds":"Mobile","data":""}]}]}} |
getSurveyBySurveyID | Allows you to fetch survey questions |
api_key: API Key given in your Manage Account section email: Primary email address. |
{
""api_key"":""YOUR API KEY"",
""email"":""REGISTERED EMAIL ID""
} |
{"status":"Success","data":{"listOfQuestion":[{"questionID":"","uniquecode":"","creationdate":"","lastupdate":"","questionnaireID":"","status":"","required":"","other":"","question_type":"","logic_apply":"","skip_logic_id":"","extra_images":"","field_type":"","question":"","option1":"","option2":"","option3":"","option4":"","option5":"","option6":"","option7":"","option8":"","option9":"","display_order":"","validation_option":"","max_length":"","survey_logic":[]}],"surveyDetails":[{"questionnaireID":"","creationdate":"","lastupdate":"","uniquecode":"","companyID":"","agentID":"","customer_information_fieldsID":"","screen_type":"","contact_form_name":"","status":"1","title":"","font":"","version":"","survey_logic":"","welcome_type":"","welcome_type_id":"","welcome_image":"","welcome_text":"","message_type":"","completion_text":"","response_count":"1","logoimage":"","company_name":"","eu_countries_status":"","eu_countries_user_status":"","privacy_data_security_policy":"","data_retention_policy":"","company_disclaimer":"","gdpr_officer_email":""}],"customerFileds":[{"field_type":"name","fieldname":"Name","option_value":"alphabetic","required":"N","min_length":"3","max_length":"20"},{"field_type":"email","fieldname":"Email","option_value":"email","required":"Y","min_length":"","max_length":""},{"field_type":"mobile","fieldname":"Mobile","option_value":"mobile","required":"N","min_length":"10","max_length":"14"}]}} |
surveySubmit | Allows you to submit survey answer |
api_key: API Key given in your Manage Account section email: Primary email address. |
{"status":"Success","data":{"uniquecode":"434333","message":"Thank you for your response"}} |
{"status":"Success","data":{"uniquecode":"434333","message":"Thank you for your response"}} |
profile | Allows you to see your company details |
api_key: API Key given in your Manage Account section email: Primary email address. |
{
""api_key"":""YOUR API KEY"",
""email"":""REGISTERED EMAIL ID""
} |
{"status":"Success","data":{"company_name":"","companyID":"","creationdate":"2018-08-18 20:02:13","subscription_enddate":"2022-10-17","number_of_users":"500","response_credit":"59388","contact_credit":"59957","folder_balance":"1.99 GB","country":"","plan_id":"","eu_countries_status":"","eu_countries_user_status":"","privacy_data_security_policy":"","data_retention_policy":"","company_disclaimer":"","gdpr_officer_email":""}} |
Standard Instructions
1. All API calls are in POST Method.
2. Standard URL www.survtapp.com/api/api/functionname
3. API Fetch Daily Limit 50