CollectorDetails
Displays detailed collector information.
Columns
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | False |
The Id of the collector. |
| SurveyId | String | False |
The Id of the survey this collector belongs to. |
| Name | String | False |
The name of the collector. |
| Status | String | False |
The collector status. Possible values are 'open' or 'closed'. |
| Type | String | False |
The collector type. Possible values are 'sms', 'weblink', or 'email'. |
| ThankYouPageIsEnabled | Boolean | False |
Specifies whether to use the custom thank you message. |
| ThankYouPageMessage | String | False |
The custom message for the thank you page, regardless of whether a custom thank you message is enabled. The default value is 'Thank you for completing our survey!'. |
| ThankYouMessage | String | False |
The message for thank you page. |
| DisqualificationMessage | String | False |
The message for disqualification page. |
| DisqualificationUrl | String | False |
The redirect URL when the respondent is disqualified. |
| CloseDate | Datetime | False |
The close date of the collector. |
| ClosedPageMessage | String | False |
The message shown when someone visits a closed survey. |
| RedirectUrl | String | False |
The redirect URL when a respondent completes the survey. |
| DisplaySurveyResults | Boolean | False |
Shows respondents survey instant results when they complete the survey. |
| EditResponseType | String | False |
When respondents can edit their response. 'until_complete', 'never', or 'always'. |
| AnonymousType | String | False |
Turns off IP tracking. For email collectors, it also removes the respondent email address and name from the response. Possible values are 'not_anonymous', 'partially_anonymous', or 'fully_anonymous'. |
| AllowMultipleResponses | Boolean | False |
Allows respondents to take a survey more than once from the same browser on the same computer. Only available for weblink collectors. |
| DateModified | Datetime | False |
The date collector was last modified. |
| Url | String | False |
If the collector is a Web Collector (type 'weblink'), the URL for the collector. |
| DateCreated | Datetime | False |
The date the collector was created. |
| PasswordEnabled | Boolean | False |
Indicates whether the collector is password protected. Only available for weblink collectors. |
| SenderEmail | String | False |
The sender email for email collectors. The user's email is used if null. |
| RedirectType | String | False |
Determines the survey end page behavior. Possible values are 'url' (redirects to the URL set in redirect_url or if none is set, shows standard SurveyMonkey thank you page), 'close' (closes the survey window or tab), or 'loop' (loops the survey back to the beginning; only available for weblink collectors with allow_multiple_responses:true). |
| Href | String | False |
The resource API URL. |
| Width | Int64 | False |
The width of your popup. |
| Height | Int64 | False |
The height of your popup. |
| BorderColor | String | False |
The border color surrounding the survey. |
| IsBrandingEnabled | Boolean | False |
Indicates whether the popup has SurveyMonkey branding. |
| Headline | String | False |
The title of the modal window surrounding the survey. |
| Message | String | False |
The message below the headline. |
| SampleRate | Int64 | False |
The percentage of people who see your popup. |
| PrimaryButtonBgColor | String | False |
The primary button’s background color. |
| PrimaryButtonTextColor | String | False |
The primary button’s text color. |
| PrimaryButtonText | String | False |
The text on the primary button. |
| SecondaryButtonBgColor | String | False |
The secondary button’s background color. |
| SecondaryButtonTextColor | String | False |
The secondary button’s text color. |
| SecondaryButtonText | String | False |
The text on the secondary button. |
| RespondentAuthentication | Bool | False |
Indicates whether Respondent Authentication is required. This is used in conjunction with SSO (single sign-on) to require respondents to sign-in. You can use Respondent Authentication to send more secure internal surveys and track the people taking your survey with SSO metadata. |
| Password | String | False |
Sets a password to restrict access to your survey. |
| ResponseLimit | Int64 | False |
Sets the collector to close after specified number of responses are collected. |
| FromCollectorId | String | False |
The collector Id to copy collector from. |