'MaintainNotificationState' has been added to the Survey, it can be used to Maintain the notifications status from the original survey when you create a new survey by using 3/Surveys?copyOfSurveyId={copyOfSurveyId}.
Now you can pass MaintainNotificationState by adding MaintainNotificationState : {boolean} to the request body fields.
V3.2.16: 2023-10-03: Endpoint to launch the survey.
The LaunchSurvey now can be used to launch the survey.
V3.2.15: 2023-09-20: Endpoints to get, insert, update, delete channel URLs in targeted panel distribution and get panels.
The UrlManagementChannel now can be used to create and update a channel in the survey.
V3.2.14: 2023-09-08: Create and update a question in the survey.
The QuestionUpsert now can be used to create and update a question in the survey.
V3.2.13: 2019-10-08: Average and median score for aggregates.
The QuestionAggregate now also contains an average and median score.
V3.2.12: 2019-07-11: Optionally strip HTML from respondent response captions.
When
retrieving respondents
, you can use &expand=Responses to include responses with captions.
Now you can strip the HTML from these captions by adding &stripHtml=true to the query string.
V3.2.11: 2019-06-28: Additional properties when retrieving Respondents with &expand=Responses
While getting a lot of requests to include additional properties in the
Responses
while retrieving Respondents, we added ScaleValue, Score and Caption.
With these new properties you will probably be able to avoid an additional call to GET - 3/surveys/{surveyId}/questions to get the question and response details.
V3.2.10: 2019-1-15: Standalone NPS questions
To simplify the survey question hierarchy, NPS questions don't consist of a parent-child combination anymore.
A NPS question is now a single independent question. There's no change in the response data since the responses have always pointed to the child question.
The former NPS child questions now have the question number, data label and question type from the parent question, while the parent questions have been removed.
V3.2.9: 2018-12-21: Scoring
ScoreMax has been added to the SurveyOptions. It contains the total of all poins available and can be used to calculate the score percentage based on the Respondent.Score.
V3.2.8: 2018-08-10: Add contacts to contact lists
With the introduction of the contact lists in our Tool, our API is now following support for this with the option to add contacts to a contact list.
V3.2.7: 2018-7-1: TLSv1.2
Starting from this date, TLS version 1.2 is required for all API connections.
This version exists since 2008, and offers serious security benefits over previous versions.
V3.2.6: 2017-11-27: Phone number validation
When creating or importing contacts, the validity of the phone number is now checked, according to the E.164 specification.
This means these phone numbers can also be used for SMS invitations.
V3.2.3: 2017-3-13: New "RespondentHash" field on Respondent
A new field has been added to Respondent: RespondentHash
This can be used as an extra security when building your own custom respondent report.
V3.2.2: 2016-8-26: Improvements based on client feedback, thanks guys!
- Added the Datalabel to Response when retrieving respondents to improve processing in your code
- Use the new Score property for a respondent, ideal for building scoreboards.
- Avoid your own transformation of the results based on the Question.ScaleTypeId, we introduce the ScaleValue property for SurveyQuestionResponse's
- New throttling limits 10.000 a day, 100 a minute
V3.2.1: 2016-5-12: New Webhook events
- Respondent.PageSubmitted: will occur everytime a respondents completes a page within a survey.
- Survey.Created: will occur everytime a user creates a new survey in your account.
V3.2.00: 2016-03-23: Add respondents
Now you can not only request the result and manage your contacts, with this new request it is possible to add respondents with their responses. Ideal for short in-App surveys, import functionalities etc.
V3.1.11: 2016-02-19: Text analysis API
With these requests you can retrieve the results of your text analysis.
V3.1.10: 2015-12-28: New Webhook event - ApiRequest.ThrottlingLimitReached
Retrieve one respondent for your survey. This respondent automatically gets all responses. A nice alternative for the combination of filter and expand in the get all respondents.
V3.1.3: 2015-05-07: Sum for aggregates
The QuestionAggregate now also contains a sum. Also for open responses with numeric values these calculations are made. This allows you to get very usefull information for subscription surveys.
V3.1.2: 2015-04-08: Response rate
It is now possible to use 'ContactGroup' as option of the response rate group by. This option allows you to get the response rates group by the different contact groups used in your survey.
V3.1.1: 2015-03-12: Response rate
Retrieve the response rate of your survey with support for filtering and grouping.
V3.1.0: 2015-02-13: Throttling
To encourage good coding practice, we use throttling per day and per minute. This is based on your entire account, not API key or IP address.
V3.0.9: 2015-01-9: Media interface
We have exposed several requests which allow you to request and add media items from the media library.
V3.0.8: 2014-12-16: Panelist - LastModifiedDate
The panelist now has a last modified date. This date is automatically updated after every update on a panelist level.
V3.0.7: 2014-12-15: Opt out list
- Since today, you can retrieve the opt out list for your account.
V3.0.5: 2014-11-19: Import contacts restricted by Group
- The Import configuration has a new property EmailMustBeUniqueWithinGroup to update contacts in the related group.
- Remove/Rename import configurations
V3.0.4: 2014-08-12: New properties when retrieving contacts
- Contact now have 2 new properties Surveys and Groups which are filled when retrieving a single contact or when expanded.
V3.0.3: 2014-07-16: New requests to manipulate contacts and contactsgroups
- We have added all CRUD operations for contacts. You can find a detailed description in the API reference.
- New requests are available to manipule contacts within a contactgroup.
V3.0.2: 2014-07-03: Add request to delete contacts
V3.0.1: 2014-06-20 : New properties for SurveyQuestionResponse, Improved documentation
- Renaming the properties Value to Caption for SurveyQuestion and SurveyQuestionResponse.
- We have added new properties to the SurveyQuestionResponse object: Hidden, Other, NotApplicable, Order and Value.
- Adaptation of the documentation regarding Respondent.Responses to indicate this is an 'expandable' property.
V2.0.9: 2014-02-03 : GetMedian, GetMean, GetMode, GetNPS return null for a survey without results
V2.0.9: 2013-12-18: Extended returnType Question
The new properties available for a Question object are Required, DataTypeId, Hidden, MinValue, MaxValue, PageNumber, OrderNumber, QuestionNumber and ParentQuestionId
V2.0.8: 2013-11-22: Extended returnType Survey
The returned Survey object will now contain all languages which are available with the new property Languages. A Language object contains IsoCode, Name and IsDefault.