Surveys
Represents full survey instruments, including metadata such as title, purpose, target audience, deployment dates, and status to manage survey lifecycle.
Columns
| Name | Type | ReadOnly | Description |
| ID [KEY] | String | True |
Unique identifier for the survey record, used internally to reference the survey entity in Vault. |
| Survey Type | String | True |
Specifies the type or classification of the survey, typically corresponding to a defined object type in the Vault object model. |
| Global ID | String | True |
System-generated unique identifier that remains consistent across Vaults in a multi-Vault environment. |
| Link | String | False |
System-managed link that provides a direct URL to the survey record within the Vault user interface. |
| Survey Name | String | False |
User-defined name of the survey, typically used as the primary label when displaying or searching for surveys. |
| Status | String | True |
Indicates the current lifecycle state of the survey, such as Draft, In Review, or Approved. |
| Created By | String | True |
Username of the Vault user who originally created the survey record. |
| Created Date | Datetime | True |
Timestamp indicating when the survey was first created in the system. |
| Last Modified By | String | True |
Username of the Vault user who most recently modified the survey record. |
| Last Modified Date | Datetime | True |
Timestamp of the last time the survey record was updated. |
| Account Types | String | False |
Comma-separated list of account types associated with the survey, such as Healthcare Professional (HCP), Healthcare Organization (HCO), or other custom classifications. |
| Assignment Type | String | False |
Defines how the survey is assigned to users, such as manually, by rule, or based on predefined roles or segments. |
| Automatically create target records | Bool | False |
Indicates whether Vault should automatically generate related target records for the survey without manual assignment. |
| Channels | String | False |
Comma-separated list of channels (such as Email, Web, In-Person) through which the survey can be distributed. |
| Enable Employee Comment | String | False |
Specifies whether employees are allowed to add comments when submitting survey responses; typically a Yes/No field stored as string. |
| End Date | Date | False |
The date after which the survey is no longer active or available to participants. |
| External ID | String | False |
Optional external identifier that links the survey to a corresponding record in an external system or integration layer. |
| Locked | Bool | False |
Indicates whether the survey is locked from further changes, typically used to prevent editing after deployment. |
| Allow users to choose targets? | Bool | False |
Specifies whether users are allowed to manually select which targets to include for the survey distribution. |
| Profile Name | String | False |
The name of the profile associated with the survey, typically defining layout, access, or behavioral rules. |
| Region | String | False |
Geographical region to which the survey applies, often used for segmenting data or tailoring survey content. |
| Score Display | String | False |
Defines how survey scores or results are presented to end users, such as numerical, graphical, or hidden. |
| Segments | String | False |
Comma-separated list of predefined segments that the survey applies to, used for filtering recipients or analyzing results. |
| Share Team | String | False |
Comma-separated list of teams with whom the survey is shared, granting them visibility or collaboration access. |
| Start Date | Date | False |
The date on which the survey became active and available for users to complete. This is used for scheduling and reporting purposes. |
| Survey Status | String | False |
The current status of the survey, such as Draft, Active, or Completed, reflecting its lifecycle progress. |
| Target Type | String | False |
Specifies the type of entity the survey is directed at, such as HCP, HCO, or internal stakeholder. |
| Included user territories | String | False |
A comma-separated list of sales or user territories where the survey is distributed. Each value identifies a unique territory. |
| iFrame Landing Page URL | String | False |
The full URL used to embed the survey within an iframe for user access via a landing page or portal. |
| Detail Group | String | False |
An optional grouping label used to categorize the survey under a specific set of related detail items or themes. |
| Product | String | False |
The associated product or brand that the survey relates to, used for marketing, compliance, or targeting purposes. |
| Owner | String | False |
The Vault user ID of the person who created or is responsible for managing the survey. |
| Maximum Possible Score | Decimal | False |
The highest numerical score a respondent can achieve in the survey, used to calculate performance or satisfaction. |
| Minimum Possible Score | Decimal | False |
The lowest numerical score a respondent can receive in the survey, establishing the baseline evaluation metric. |
| Expired | String | True |
Indicates whether the survey has passed its expiration date and is no longer available for completion. Values can include Yes or No. |
| Legacy CRM Id | String | False |
The identifier used in the legacy Customer Relationship Management (CRM) system for referencing this survey, supporting historical data migration or integration. |
| Language | String | False |
The language in which the survey is presented to the user, such as English, French, or Japanese. |
| Lifecycle | String | True |
The overall lifecycle model applied to the survey, defining the progression from creation to retirement. |
| Lifecycle State | String | True |
The current state within the lifecycle model, such as Initiated, In Review, or Finalized. |
| Lifecycle State Stage ID | String | True |
A system-generated identifier for the stage within the current lifecycle state, used internally for stage tracking. |
| Lifecycle Stage | String | True |
The name of the current lifecycle stage, providing insight into the progress of the survey within its configured workflow. |
| Application Profile | String | False |
The Vault application profile assigned to the survey, which determines UI configuration and feature access. |