Retrieve all contacts which match the passed criteria
|
GET
|
3/contacts?top={top}&skip={skip}&select={select}&filter={filter}&orderby={orderby}&expand={expand}
|
Retrieve all contacts which match the passed criteria
|
Retrieve a contact by id.
|
GET
|
3/contacts/{contactId}
|
Retrieve a contact by id.
|
Create a new contact in a survey
|
POST
|
3/contacts?surveyId={surveyId}&logComment={logComment}
|
Create a new contact in a survey
|
|
DELETE
|
3/contacts/{contactId}
|
Remove a contact by id.
|
Create a new import configuration.
|
POST
|
3/contacts/import/configs
|
Create a new import configuration.
|
Retrieve the existing import configurations.
|
GET
|
3/contacts/import/configs?top={top}&skip={skip}&select={select}&filter={filter}&orderby={orderby}&expand={expand}
|
Retrieve the existing import configurations.
|
Retrieve an existing import configuration by its id.
|
GET
|
3/contacts/import/configs/{importConfigId}
|
Retrieve an existing import configuration by its id.
|
Retrieve all available options which you can use as TargetColumnName in the ImportColumnMapping.
|
GET
|
3/contacts/import/targetcolumns
|
Retrieve all available options which you can use as TargetColumnName in the ImportColumnMapping.
|
Import contacts in bulk. Depending on your import configuration you can receive a email notification on each import.
You can also trace the item in the queue when requesting the result.
|
POST
|
3/contacts/import/{importConfigId}
|
Import contacts in bulk. Depending on your import configuration you can receive a email notification on each import.
You can also trace the item in the queue when requesting the result.
|
Get the result of an import.
|
GET
|
3/contacts/import/{queueItemId}
|
Get the result of an import.
|
Retrieve the opt-out list of your account taking the passed criteria into account
|
GET
|
3/contacts/optouts?top={top}&skip={skip}&select={select}&filter={filter}&orderby={orderby}
|
Retrieve the opt-out list of your account taking the passed criteria into account
|
|
GET
|
3/surveys/{surveyId}?lang={lang}&includeQuestions={includeQuestions}
|
Retrieve a survey by id.
|
Gets the response rate for a survey.
|
GET
|
3/surveys/{surveyId}/responserate?filter={filter}&groupby={groupby}
|
Gets the response rate for a survey.
|
Early access feature - Launch a survey.
|
POST
|
3/surveys/{surveyId}/launch
|
Early access feature - Launch a survey.
|
Retrieve all questions from a survey which match the passed criteria.
|
GET
|
3/surveys/{surveyId}/questions?asFlatList={asFlatList}&stripHtml={stripHtml}&lang={lang}&top={top}&skip={skip}&select={select}&filter={filter}
|
Retrieve all questions from a survey which match the passed criteria.
|
Retrieve a question from a survey by its datalabel.
|
GET
|
3/surveys/{surveyId}/questions/{questionId}?lang={lang}
|
Retrieve a question from a survey by its datalabel.
|
Retrieve the reults in aggregate for a question by id or datalabel.
Hint: If you're looking to get the individual answers to a survey, download the respondents.
|
GET
|
3/surveys/{surveyId}/questions/{questionId}/result?lang={lang}&filter={filter}
|
Retrieve the reults in aggregate for a question by id or datalabel.
Hint: If you're looking to get the individual answers to a survey, download the respondents.
|
Retrieve the aggregates (Average, Median, StandardDeviation, NPS) from a question by the question label.
|
GET
|
3/surveys/{surveyId}/questions/{questionId}/aggregates?filter={filter}&period={period}&responseId={responseId}
|
Retrieve the aggregates (Average, Median, StandardDeviation, NPS) from a question by the question label.
|
Early access feature - Retrieve a question from a survey by its id.
|
GET
|
3/surveys/{surveyId}/questions/{questionId}/read
|
Early access feature - Retrieve a question from a survey by its id.
|
Early access feature - Creates a question in a survey.
|
POST
|
3/surveys/{surveyId}/questions
|
Early access feature - Creates a question in a survey.
|
Retrieve all respondents from a survey which match the passed criteria. Use the expand=Responses parameter to immediately include the responses of a respondent.
|
GET
|
3/surveys/{surveyId}/respondents?langCode={langCode}&top={top}&skip={skip}&select={select}&filter={filter}&orderby={orderby}&expand={expand}&stripHtml={stripHtml}&filterJSON={filterJSON}&filterIds={filterIds}
|
Retrieve all respondents from a survey which match the passed criteria. Use the expand=Responses parameter to immediately include the responses of a respondent.
|
Get the respondent with responses from a survey.
|
GET
|
3/surveys/{surveyId}/respondents/{respondentId}
|
Get the respondent with responses from a survey.
|
Add responses for a new respondent
|
POST
|
3/surveys/{surveyId}/respondents?includeSuccessResponses={includeSuccessResponses}
|
Add responses for a new respondent
|
Retrieve all contacts from a survey which match the passed criteria.
|
GET
|
3/surveys/{surveyId}/contacts?top={top}&skip={skip}&select={select}&filter={filter}&orderby={orderby}
|
Retrieve all contacts from a survey which match the passed criteria.
|
Retrieve a contact from a survey by contactId.
|
GET
|
3/surveys/{surveyId}/contacts/{contactId}
|
Retrieve a contact from a survey by contactId.
|
Retrieve the amount of unique values for the custom fields for a survey.
|
GET
|
3/surveys/{surveyId}/contacts/fieldvaluecount
|
Retrieve the amount of unique values for the custom fields for a survey.
|
Early access feature - Gets all the channel URLs for the targeted panel
|
GET
|
3/surveys/{surveyId}/channels/targetedPanels/Urls
|
Early access feature - Gets all the channel URLs for the targeted panel
|
Early access feature - Gets specific channel details for the targeted panel
|
GET
|
3/surveys/{surveyId}/channels/targetedPanels/Urls/{urlId}
|
Early access feature - Gets specific channel details for the targeted panel
|
Early access feature - Creates channel URL for the targeted panel in a survey
|
POST
|
3/surveys/{surveyId}/channels/targetedpanels/Urls
|
Early access feature - Creates channel URL for the targeted panel in a survey
|
Early access feature - Creates page branch logic.
|
POST
|
3/surveys/{surveyId}/pages/{pageNumber}/branching
|
Early access feature - Creates page branch logic.
|
Early access feature - Gets page branch logic.
|
GET
|
3/surveys/{surveyId}/pages/{pageNumber}/branching
|
Early access feature - Gets page branch logic.
|
Retrieve all media items from a media folder.
|
GET
|
3/media/folders/{FolderId}?MediaTypeId={MediaTypeId}&Name={Name}
|
Retrieve all media items from a media folder.
|
Retrieve a media item by id.
|
GET
|
3/media/{MediaId}
|
Retrieve a media item by id.
|
Add a new file to the media library.
|
POST
|
3/media/folders/{FolderId}?Description={Description}
|
Add a new file to the media library.
|
Retrieve the complete tree of media folders.
|
GET
|
3/media/folders
|
Retrieve the complete tree of media folders.
|
Default API-call which will return the urls to the root requests in the Links property.
|
GET
|
3
|
Default API-call which will return the urls to the root requests in the Links property.
|
To check how your application behaves when running into a throttling exception, you can use this request to get the throttling exception.
|
GET
|
3/throttle
|
To check how your application behaves when running into a throttling exception, you can use this request to get the throttling exception.
|
Retrieve the open answer questions
|
GET
|
3/textanalysis/{surveyId}/questions?lang={lang}
|
Retrieve the open answer questions
|
Retrieve the open answers
|
GET
|
3/textanalysis/{surveyId}/questions/{questionId}?lang={lang}&top={top}&skip={skip}&filter={filter}&filterTagIds={filterTagIds}&filterSentimentScore={filterSentimentScore}&orderby={orderby}
|
Retrieve the open answers
|
Retrieve a list of available tags for this question
|
GET
|
3/textanalysis/{surveyId}/questions/{questionId}/tags?lang={lang}
|
Retrieve a list of available tags for this question
|
Retrieve the tagging aggregates
|
GET
|
3/textanalysis/{surveyId}/questions/{questionId}/aggregates?lang={lang}
|
Retrieve the tagging aggregates
|
Occurs when a new survey is created.
|
POST
|
webhooks/event/Survey/Created
|
Occurs when a new survey is created.
|
Get the roles related to the current key.
|
GET
|
3/keys/current
|
Get the roles related to the current key.
|
Retrieve all webhooks available for you.
|
GET
|
3/hooks
|
Retrieve all webhooks available for you.
|
Retrieve a webhook configuration by ID.
|
GET
|
3/hooks/{WebhookId}
|
Retrieve a webhook configuration by ID.
|
Retrieve a demo object of the webhook you just created. The data returned in the demo is fixed and only depending on the type of event used in your webhook, it is not related to any survey, contact, respondent, ... in your account.
|
GET
|
3/hooks/{WebhookId}/demo
|
Retrieve a demo object of the webhook you just created. The data returned in the demo is fixed and only depending on the type of event used in your webhook, it is not related to any survey, contact, respondent, ... in your account.
|
Retrieve the available events to which you can attach your web hooks.
|
GET
|
3/hooks/events
|
Retrieve the available events to which you can attach your web hooks.
|
Occurs when a respondent completes a survey.
|
POST
|
webhooks/event/Respondent/Complete
|
Occurs when a respondent completes a survey.
|
Occurs for each page a respondent completes.
|
POST
|
webhooks/event/Respondent/PageSubmitted
|
Occurs for each page a respondent completes.
|
Occurs when a Panelist doesn't want to receive survey invitations anymore.
|
POST
|
webhooks/event/Panelist/Optout
|
Occurs when a Panelist doesn't want to receive survey invitations anymore.
|
Occurs when an email to a Panelist bounced.
|
POST
|
webhooks/event/Panelist/Bounced
|
Occurs when an email to a Panelist bounced.
|
Occurs once a new webhook has been created.
|
POST
|
webhooks/event/Webhook/Created
|
Occurs once a new webhook has been created.
|
|
POST
|
webhooks/event/ApiRequest/ThrottlingLimitReached
|
Occurs the first time the API throttling limit is reached for your account.
|
Retrieve a contact group by id.
|
GET
|
3/contactgroups/{GroupId}
|
Retrieve a contact group by id.
|
Updates the contact group by its id.
|
PUT
|
3/contactgroups/{GroupId}
|
Updates the contact group by its id.
|
Retrieve the browser id and browser names for all browsers which we identify when completing a survey. (only in English)
|
GET
|
3/lookup/browsers
|
Retrieve the browser id and browser names for all browsers which we identify when completing a survey. (only in English)
|
Retrieve all contacts folders which match the passed criteria
|
GET
|
3/ContactFolders?top={top}&skip={skip}&select={select}&filter={filter}&orderby={orderby}
|
Retrieve all contacts folders which match the passed criteria
|
Retrieve a contact folder by id.
|
GET
|
3/ContactFolders/{Id}
|
Retrieve a contact folder by id.
|
Create a new contacts folder.
|
POST
|
3/ContactFolders
|
Create a new contacts folder.
|
Update a contacts folder name by its id.
|
PUT
|
3/ContactFolders/{Id}
|
Update a contacts folder name by its id.
|
Retrieve all surveys which match the passed criteria.
|
GET
|
3/Surveys?lang={lang}&top={top}&skip={skip}&select={select}&filter={filter}&orderby={orderby}&expand={expand}
|
Retrieve all surveys which match the passed criteria.
|
|
POST
|
3/Surveys?copyOfSurveyId={copyOfSurveyId}
|
Create a new survey.
|
Retrieve all contactgroups which match the passed criteria
|
GET
|
3/ContactGroups?top={top}&skip={skip}&select={select}&filter={filter}&orderby={orderby}
|
Retrieve all contactgroups which match the passed criteria
|
Create a new contactgroup.
|
POST
|
3/ContactGroups
|
Create a new contactgroup.
|