The following API calls are currently available for the SurveyPage object:
For info on returned fields and example returns go to SurveyPage Returned Fields.
GET LIST - Get a list of all of your survey pages. View Example Return.
https://api.alchemer.com/v5/survey/123456/surveypage
| Parameters | Example | Required |
|---|---|---|
| Authentication Credentials | api_token=abcd12345&api_token_secret=abcd12345 | True |
GET SURVEYPAGE - Get information about a specified survey page. View Example Return.
https://api.alchemer.com/v5/survey/123456/surveypage/1
| Parameters | Example | Required |
|---|---|---|
| Authentication Credentials | api_token=abcd12345&api_token_secret=abcd12345 | True |
CREATE SURVEYPAGE - Create a new survey page. View Example Return.
https://api.alchemer.com/v5/survey/123456/surveypage?_method=PUT&title=Title&after=3
| Parameters | Example | Required |
|---|---|---|
| Authentication Credentials | api_token=abcd12345&api_token_secret=abcd12345 | True |
| title | My New Page | True |
| description | Page description text | False |
| after | ID of page to follow | False |
| properties[hidden] | true | False |
| properties[piped_from] | ID of question to pipe from | False |
UPDATE SURVEYPAGE - Update a specified survey page. View Example Return.
https://api.alchemer.com/v5/survey/123456/surveypage/3?_method=POST
| Parameters | Example | Required |
|---|---|---|
| Authentication Credentials | api_token=abcd12345&api_token_secret=abcd12345 | True |
| title | My New Page | False |
| description | Page description text | False |
| properties[hidden] | true | False |
| properties[piped_from] | ID of question to pipe from | False |
DELETE SURVEYPAGE - Delete a specified survey page. View Example Return.
https://api.alchemer.com/v5/survey/123456/surveypage/3?_method=DELETE
| Parameters | Example | Required |
|---|---|---|
| Authentication Credentials | api_token=abcd12345&api_token_secret=abcd12345 | True |