Hateoas

HATEOAS related to this object. It wil contain relevant url's such as previous and next page for paged results, create/update/delete action. These url's can be used in your application for the next steps in your application logic.

NameDescriptionTypeAdditional information
Self

Url for the GET request of the relevant object.

SelfLink

Create

Url for the CREATE request of the relevant object.

CreateLink

Update

Url for the UPDATE request of the relevant object.

UpdateLink

Delete

Url for the DELETE request of the relevant object.

DeleteLink

Next

Url for the next paged results. Only available in case a paginated list is returned and we are not on the last paged results.

NextLink

Previous

Url for the previous paged results. Only available in case a paginated list is returned and we are not on the first paged results.

PreviousLink

Help

Url to the documentation page of the relevant object.

HelpLink

Progress

Url where to follow the progress of a long-running process.

ProgressLink

AlternateLink

Url which can be used as alternative to your request. This will be used in case you original request was Obsolete.

AlternateLink

ListLink

Url which can be used to get a list of all object for this type. This will be available in case of an ItemNotFound exception

ListLink

Other

All other interesting links which we would like to offer.

Collection of Link

Related Methods

Verb Url Description
GET 3/contacts?top={top}&skip={skip}&select={select}&filter={filter}&orderby={orderby}&expand={expand}

Retrieve all contacts which match the passed criteria

GET 3/contacts/{ContactId}

Retrieve a contact by id.

POST 3/contacts?SurveyId={SurveyId}

Create a new contact in a survey

DELETE 3/contacts/{ContactId}

Remove a contact by id.

POST 3/contacts/import/configs

Create a new import configuration.

GET 3/contacts/import/configs?top={top}&skip={skip}&select={select}&filter={filter}&orderby={orderby}&expand={expand}

Retrieve the existing import configurations.

GET 3/contacts/import/configs/{ImportConfigId}

Retrieve an existing import configuration by its id.

GET 3/contacts/import/targetcolumns

Retrieve all available options which you can use as TargetColumnName in the ImportColumnMapping.

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 3/contacts/import/{QueueItemId}

Get the result of an import.

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.

GET 3/surveys/{SurveyId}/responserate?filter={filter}&groupby={groupby}

Gets the response rate for a survey.

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.

GET 3/surveys/{SurveyId}/questions/{QuestionId}?lang={lang}

Retrieve a question from a survey by its datalabel.

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.

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.

GET 3/surveys/{SurveyId}/respondents?top={top}&skip={skip}&select={select}&filter={filter}&orderby={orderby}&expand={expand}

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/{RespondentId}

Get the respondent with responses from a survey.

POST 3/surveys/{SurveyId}/respondents?IncludeSuccessResponses={IncludeSuccessResponses}

Add responses for a new respondent

GET 3/surveys/{SurveyId}/panelists?top={top}&skip={skip}&select={select}&filter={filter}&orderby={orderby}

Retrieve all panelists from a survey which match the passed criteria.

GET 3/surveys/{SurveyId}/panelists/{ContactId}

Retrieve a panelist from a survey by contactid.

GET 3/surveys/{SurveyId}/panelists/fieldvaluecount

Retrieve the amount of unique values for the fields in the panel for a survey.

GET 3/media/folders/{FolderId}?MediaTypeId={MediaTypeId}&Name={Name}

Retrieve all media items from a media folder.

GET 3/media/{MediaId}

Retrieve a media item by id.

POST 3/media/folders/{FolderId}?Description={Description}

Add a new file to the media library.

GET 3/media/folders

Retrieve the complete tree of media folders.

GET 3

Default API-call which will return the urls to the root requests in the Links property.

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.

GET 3/textanalysis/{SurveyId}/questions?lang={lang}

Retrieve the open answer questions

GET 3/textanalysis/{SurveyId}/questions/{QuestionId}?lang={lang}&top={top}&skip={skip}&filter={filter}&filterTagIds={filterTagIds}&filterSentimentScore={filterSentimentScore}&orderby={orderby}

Retrieve the open answers

GET 3/textanalysis/{SurveyId}/questions/{QuestionId}/tags?lang={lang}

Retrieve a list of available tags for this question

GET 3/textanalysis/{SurveyId}/questions/{QuestionId}/aggregates?lang={lang}

Retrieve the tagging aggregates

POST webhooks/event/Survey/Created

Occurs when a new survey is created.

GET 3/keys/current

Get the roles related to the current key.

GET 3/hooks

Retrieve all webhooks available for you.

GET 3/hooks/{WebhookId}

Retrieve a webhook configuration by ID.

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.

GET 3/hooks/events

Retrieve the available events to which you can attach your web hooks.

POST webhooks/event/Respondent/Complete

Occurs when a respondent completes a survey.

POST webhooks/event/Respondent/PageSubmitted

Occurs for each page a respondent completes.

POST webhooks/event/Panelist/Optout

Occurs when a Panelist doesn't want to receive survey invitations anymore.

POST webhooks/event/Panelist/Bounced

Occurs when an email to a Panelist bounced.

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.

GET 3/contactgroups/{GroupId}

Retrieve a contact group by id.

PUT 3/contactgroups/{GroupId}

Updates the contact group by its id.

GET 3/lookup/browsers

Retrieve the browser id and browser names for all browsers which we identify when completing a survey. (only in English)

GET 3/ContactFolders?top={top}&skip={skip}&select={select}&filter={filter}&orderby={orderby}

Retrieve all contacts folders which match the passed criteria

GET 3/ContactFolders/{Id}

Retrieve a contact folder by id.

POST 3/ContactFolders

Create a new contacts folder.

PUT 3/ContactFolders/{Id}

Update a contacts folder name by its id.

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 trial survey. Upgrading the survey to a paid survey can be done in our Tool.

GET 3/ContactGroups?top={top}&skip={skip}&select={select}&filter={filter}&orderby={orderby}

Retrieve all contactgroups which match the passed criteria

POST 3/ContactGroups

Create a new contactgroup.