Surveys
Last updated
Queries
survey query
Retrieve survey data from the Viio GraphQL API.
survey(id: ID!): Survey
Returns: Survey
Arguments for survey
| Name | Description |
|---|---|
id (ID!) |
surveys query
Retrieve surveys data from the Viio GraphQL API.
surveys(first: Int, after: String, last: Int, before: String, where: SurveyFilterInput, order: [SurveySortInput!]): SurveysConnection
Returns: SurveysConnection
Arguments for surveys
| Name | Description |
|---|---|
where (SurveyFilterInput) | |
order ([SurveySortInput!]) | |
first (Int) | Returns the first n elements from the list. |
after (String) | Returns elements after the specified cursor. |
last (Int) | Returns the last n elements from the list. |
before (String) | Returns elements before the specified cursor. |
surveyContacts query
Everyone a survey can be sent to, reachable or not.
surveyContacts(first: Int, after: String, last: Int, before: String, where: SurveyContactFilterInput, order: [SurveyContactSortInput!]): SurveyContactsConnection
Returns: SurveyContactsConnection
Arguments for surveyContacts
| Name | Description |
|---|---|
where (SurveyContactFilterInput) | |
order ([SurveyContactSortInput!]) | |
first (Int) | Returns the first n elements from the list. |
after (String) | Returns elements after the specified cursor. |
last (Int) | Returns the last n elements from the list. |
before (String) | Returns elements before the specified cursor. |
surveyRecipientsCount query
The number of people a survey sent to this selection would reach.
surveyRecipientsCount(input: SurveyRecipientsCountInput!): Int!
Returns: Int!
Arguments for surveyRecipientsCount
| Name | Description |
|---|---|
input (SurveyRecipientsCountInput!) |
Mutations
createSurvey mutation
Run the createSurvey mutation through the Viio GraphQL API.
createSurvey(input: CreateSurveyInput!): CreateSurveyPayload!
Returns: CreateSurveyPayload!
Arguments for createSurvey
| Name | Description |
|---|---|
input (CreateSurveyInput!) |
removeSurveys mutation
Run the removeSurveys mutation through the Viio GraphQL API.
removeSurveys(where: SurveyFilterInput): RemoveSurveysPayload!
Returns: RemoveSurveysPayload!
Arguments for removeSurveys
| Name | Description |
|---|---|
where (SurveyFilterInput) |
sendSurveyReminder mutation
Run the sendSurveyReminder mutation through the Viio GraphQL API.
sendSurveyReminder(input: SendSurveyReminderInput!): SendSurveyReminderPayload!
Returns: SendSurveyReminderPayload!
Arguments for sendSurveyReminder
| Name | Description |
|---|---|
input (SendSurveyReminderInput!) |
sendTestSurvey mutation
Run the sendTestSurvey mutation through the Viio GraphQL API.
sendTestSurvey(input: SendTestSurveyInput!): SendTestSurveyPayload!
Returns: SendTestSurveyPayload!
Arguments for sendTestSurvey
| Name | Description |
|---|---|
input (SendTestSurveyInput!) |
Objects
CreateSurveyPayload object
Fields returned by the CreateSurveyPayload object type.
| Name | Description |
|---|---|
survey (CreatedSurvey) | |
errors ([CreateSurveyError!]) |
FailedToCreateSurveyError object
Fields returned by the FailedToCreateSurveyError object type.
| Name | Description |
|---|---|
message (String!) |
FailedToRemoveSurveysError object
Fields returned by the FailedToRemoveSurveysError object type.
| Name | Description |
|---|---|
message (String!) |
InProgressSurveyReminderStatus object
Fields returned by the InProgressSurveyReminderStatus object type.
| Name | Description |
|---|---|
initiatedAt (DateTime) |
ProductSurveyScope object
Fields returned by the ProductSurveyScope object type.
RemoveSurveysPayload object
Fields returned by the RemoveSurveysPayload object type.
| Name | Description |
|---|---|
removedCount (Int) | |
errors ([RemoveSurveyError!]) |
SendSurveyError object
Fields returned by the SendSurveyError object type.
| Name | Description |
|---|---|
message (String!) |
SendSurveyReminderPayload object
Fields returned by the SendSurveyReminderPayload object type.
| Name | Description |
|---|---|
survey (CreatedSurvey) | |
errors ([SurveyReminderError!]) |
SendTestSurveyPayload object
Fields returned by the SendTestSurveyPayload object type.
| Name | Description |
|---|---|
ok (Boolean!) | |
errors ([SendTestSurveyError!]) |
SentSurveyReminderStatus object
Fields returned by the SentSurveyReminderStatus object type.
| Name | Description |
|---|---|
recipientsCount (Int!) |
Survey object
Fields returned by the Survey object type.
| Name | Description |
|---|---|
id (ID!) | |
createdAt (DateTime!) | |
createdByUserId (ID!) | |
status (SurveyStatus!) | |
sentAt (DateTime) | |
channels ([SurveyChannel!]!) | |
title (String!) | |
context (SurveyContext!) | |
scope (SurveyScope!) | |
messages (SurveyMessages!) | |
recipientsSelection (SurveyRecipientsSelection!) | |
reminders ([SurveyReminder!]!) | |
questions ([SurveyQuestion!]) | |
completion (SurveyCompletion!) | |
recipients (SurveyRecipientsConnection) | |
createdBy (User) |
SurveyApplicationUserRecipientsSelection object
Which of the product's users the survey goes to.
| Name | Description |
|---|---|
applicationUserIds ([ID!]) | Only these application users. |
groupIds ([ID!]) | Only application users in these employee groups. |
dataSources ([DiscoverySourceName!]) | Only application users seen in these sources. |
SurveyChannel object
Fields returned by the SurveyChannel object type.
| Name | Description |
|---|---|
type (SurveyChannelType!) |
SurveyCompletion object
Fields returned by the SurveyCompletion object type.
| Name | Description |
|---|---|
recipients (Int!) | |
responses (Int!) | |
rate (Float!) |
SurveyConditionGroup object
The rules that decide whether a question is shown.
| Name | Description |
|---|---|
operator (SurveyConditionGroupOperator!) | Whether every rule or any rule has to match. |
rules ([SurveyConditionRule!]!) | The rules matched against earlier answers. |
SurveyContact object
Someone a survey can be sent to.
| Name | Description |
|---|---|
id (ID!) | The contact's identifier. |
channel (SurveyChannelType!) | The channel the contact is reached on. |
externalKey (SurveyContactExternalKey!) | Coordinates of a contact in an external system. |
email (String!) | The contact's email address. |
name (String) | The contact's name. |
reachable (Boolean!) | Whether a survey sent to this contact would arrive. |
checkedAt (DateTime!) | When the contact was last checked for reachability. |
lastReachableAt (DateTime) | When the contact was last reachable. |
SurveyContactExternalKey object
Coordinates of a contact in an external system.
| Name | Description |
|---|---|
tenant (String) | The tenant the contact belongs to in the external system. |
sourceId (String!) | The contact's id in the external system. |
SurveyContactsConnection object
A connection to a list of items.
| Name | Description |
|---|---|
pageInfo (PageInfo!) | Information to aid in pagination. |
edges ([SurveyContactsEdge!]) | A list of edges. |
nodes ([SurveyContact!]) | A flattened list of the nodes. |
totalCount (Int!) | Identifies the total count of items in the connection. |
SurveyContactsEdge object
An edge in a connection.
| Name | Description |
|---|---|
cursor (String!) | A cursor for use in pagination. |
node (SurveyContact!) | The item at the end of the edge. |
SurveyEmployeeRecipientsSelection object
Which employees the survey goes to.
| Name | Description |
|---|---|
employeeIds ([ID!]) | Only these employees. |
groupIds ([ID!]) | Only employees in these groups. |
SurveyMessages object
Fields returned by the SurveyMessages object type.
| Name | Description |
|---|---|
introduction (String!) |
SurveyNotFoundError object
Fields returned by the SurveyNotFoundError object type.
| Name | Description |
|---|---|
message (String!) |
SurveyRecipient object
Someone a sent survey was delivered to, whether or not they responded.
| Name | Description |
|---|---|
id (ID!) | The recipient's identifier. |
employeeId (ID) | The directory employee the recipient was resolved from, if any. |
email (String!) | The email address the survey was addressed to. |
firstName (String) | The recipient's first name as it was at send time. |
lastName (String) | The recipient's last name as it was at send time. |
sentAt (DateTime!) | When the survey was sent to this recipient. |
respondedAt (DateTime) | When the recipient completed the survey; null while there is no response. |
answers ([SurveyAnswer!]!) | What the recipient answered; empty while there is no response. |
employee (Employee) | Directory employee the recipient was resolved from. |
SurveyRecipientsConnection object
A connection to a list of items.
| Name | Description |
|---|---|
pageInfo (PageInfo!) | Information to aid in pagination. |
edges ([SurveyRecipientsEdge!]) | A list of edges. |
nodes ([SurveyRecipient!]) | A flattened list of the nodes. |
totalCount (Int!) | Identifies the total count of items in the connection. |
SurveyRecipientsEdge object
An edge in a connection.
| Name | Description |
|---|---|
cursor (String!) | A cursor for use in pagination. |
node (SurveyRecipient!) | The item at the end of the edge. |
SurveyRecipientsSelection object
Who the survey goes to.
| Name | Description |
|---|---|
employees (SurveyEmployeeRecipientsSelection) | The employees included. |
applicationUsers (SurveyApplicationUserRecipientsSelection) | The application users included. |
emails ([String!]) | The email addresses included. |
SurveyReminder object
Fields returned by the SurveyReminder object type.
| Name | Description |
|---|---|
id (ID!) | |
type (SurveyReminderType!) | |
createdAt (DateTime!) | |
status (SurveyReminderStatus!) |
SurveyReminderAlreadyInProgressError object
Fields returned by the SurveyReminderAlreadyInProgressError object type.
| Name | Description |
|---|---|
message (String!) |
SurveyReminderNoRecipientsError object
Fields returned by the SurveyReminderNoRecipientsError object type.
| Name | Description |
|---|---|
message (String!) |
SurveysConnection object
A connection to a list of items.
| Name | Description |
|---|---|
pageInfo (PageInfo!) | Information to aid in pagination. |
edges ([SurveysEdge!]) | A list of edges. |
nodes ([Survey!]) | A flattened list of the nodes. |
totalCount (Int!) | Identifies the total count of items in the connection. |
SurveysEdge object
An edge in a connection.
| Name | Description |
|---|---|
cursor (String!) | A cursor for use in pagination. |
node (Survey!) | The item at the end of the edge. |
VendorSurveyScope object
Fields returned by the VendorSurveyScope object type.
| Name | Description |
|---|---|
vendorId (ID!) | |
vendorName (String) | |
vendor (Vendor) |
Input Types
ComparableEmployeeOperationFilterInput input
Matches any of the given IDs.
| Name | Description |
|---|---|
in ([ID!]!) | The IDs to match. |
ComparableUserOperationFilterInput input
Matches any of the given IDs.
| Name | Description |
|---|---|
in ([ID!]!) | The IDs to match. |
CreateSurveyDefinitionInput input
A survey to create.
| Name | Description |
|---|---|
title (String!) | The survey's name. |
context (SurveyContext!) | Whether one response is collected per license or per person. |
scope (SurveyScopeInput!) | The product or vendor the survey is about. |
channels ([SurveyChannelInput!]!) | Where the survey is delivered. |
messages (SurveyMessagesInput!) | The texts recipients see. |
questions ([SurveyQuestionInput!]!) | The questions to ask, in order. |
recipients (SurveyRecipientsInput!) | Who receives the survey. |
CreateSurveyInput input
What to create.
| Name | Description |
|---|---|
survey (CreateSurveyDefinitionInput) | The survey to create. |
DataSourceFilterInput input
Matches any of the given sources.
| Name | Description |
|---|---|
in ([DiscoverySourceName!]!) | The sources to match. |
ListComparableEmployeeOperationFilterInput input
Matches when at least one entry matches.
| Name | Description |
|---|---|
some (ComparableEmployeeOperationFilterInput!) | The condition to match. |
ListComparableUserOperationFilterInput input
Matches when at least one entry matches.
| Name | Description |
|---|---|
some (ComparableUserOperationFilterInput!) | The condition to match. |
SendSurveyReminderInput input
Input fields accepted by SendSurveyReminderInput.
| Name | Description |
|---|---|
surveyId (ID!) |
SendTestRecipientEmailInput input
Input fields accepted by SendTestRecipientEmailInput.
| Name | Description |
|---|---|
email (String!) | |
firstName (String) | |
lastName (String) |
SendTestRecipientInput input
Input fields accepted by SendTestRecipientInput.
| Name | Description |
|---|---|
slack (SendTestRecipientSlackInput) | |
email (SendTestRecipientEmailInput) | |
teams (SendTestRecipientTeamsInput) | Sends the test survey to Microsoft Teams. |
SendTestRecipientSlackInput input
Input fields accepted by SendTestRecipientSlackInput.
| Name | Description |
|---|---|
sourceId (String!) | |
tenant (String!) |
SendTestRecipientTeamsInput input
Microsoft Teams recipient details for a test survey.
| Name | Description |
|---|---|
sourceId (String!) | Microsoft Entra object ID of the recipient. |
tenant (String!) | Microsoft Entra tenant ID of the recipient. |
firstName (String) | First name displayed in the survey card greeting. |
SendTestSurveyDefinitionInput input
Input fields accepted by SendTestSurveyDefinitionInput.
| Name | Description |
|---|---|
recipient (SendTestRecipientInput!) | |
title (String!) | |
context (SurveyContext!) | |
scope (SurveyScopeInput!) | |
messages (SurveyMessagesInput!) | |
questions ([SurveyQuestionInput!]!) |
SendTestSurveyInput input
Input fields accepted by SendTestSurveyInput.
| Name | Description |
|---|---|
survey (SendTestSurveyDefinitionInput) |
SurveyAnswerFilterInput input
Input fields accepted by SurveyAnswerFilterInput.
| Name | Description |
|---|---|
questionKey (String!) | |
yesNo (BooleanOperationFilterInput) | |
rating (IntOperationFilterInput) | |
text (StringOperationFilterInput) | |
selectedOption (StringOperationFilterInput) | |
otherText (StringOperationFilterInput) | |
answered (Boolean) |
SurveyApplicationUsersInput input
Which of the product's users to pick.
| Name | Description |
|---|---|
id (ComparableUserOperationFilterInput) | Only these application users. |
groupIds (ListComparableUserOperationFilterInput) | Only application users in these employee groups. |
dataSource (DataSourceFilterInput) | Only application users seen in these sources. |
SurveyChannelInput input
Input fields accepted by SurveyChannelInput.
| Name | Description |
|---|---|
type (SurveyChannelType!) |
SurveyChannelTypeOperationFilterInput input
Input fields accepted by SurveyChannelTypeOperationFilterInput.
| Name | Description |
|---|---|
eq (SurveyChannelType) | Matches when the field value is exactly equal to the given value. |
neq (SurveyChannelType) | Matches when the field value is not equal to the given value. |
in ([SurveyChannelType!]) | Matches when the field value is one of the values in the given list. |
nin ([SurveyChannelType!]) | Matches when the field value is none of the values in the given list. |
SurveyConditionGroupInput input
Input fields accepted by SurveyConditionGroupInput.
| Name | Description |
|---|---|
operator (SurveyConditionGroupOperator!) | |
rules ([SurveyConditionRuleInput!]!) |
SurveyConditionRuleInput input
Input fields accepted by SurveyConditionRuleInput.
| Name | Description |
|---|---|
yesNo (SurveyYesNoConditionRuleInput) | |
ratingValue (SurveyRatingValueConditionRuleInput) | |
ratingBetween (SurveyRatingBetweenConditionRuleInput) | |
radioGroupOption (SurveyRadioGroupOptionConditionRuleInput) | |
radioGroupOther (SurveyRadioGroupOtherConditionRuleInput) |
SurveyContactExternalKeyFilterInput input
Input fields accepted by SurveyContactExternalKeyFilterInput.
| Name | Description |
|---|---|
and ([SurveyContactExternalKeyFilterInput!]) | Matches when every one of the given filter expressions matches (logical AND). |
or ([SurveyContactExternalKeyFilterInput!]) | Matches when at least one of the given filter expressions matches (logical OR). |
tenant (StringOperationFilterInput) | The tenant the contact belongs to in the external system. |
sourceId (StringOperationFilterInput) | The contact's id in the external system. |
SurveyContactExternalKeySortInput input
Input fields accepted by SurveyContactExternalKeySortInput.
| Name | Description |
|---|---|
tenant (SortEnumType) | The tenant the contact belongs to in the external system. |
sourceId (SortEnumType) | The contact's id in the external system. |
SurveyContactFilterInput input
Input fields accepted by SurveyContactFilterInput.
| Name | Description |
|---|---|
and ([SurveyContactFilterInput!]) | Matches when every one of the given filter expressions matches (logical AND). |
or ([SurveyContactFilterInput!]) | Matches when at least one of the given filter expressions matches (logical OR). |
id (ComparableIdTypeOperationFilterInput) | The contact's identifier. |
channel (SurveyChannelTypeOperationFilterInput) | The channel the contact is reached on. |
externalKey (SurveyContactExternalKeyFilterInput) | Coordinates of a contact in an external system. |
email (StringOperationFilterInput) | The contact's email address. |
name (StringOperationFilterInput) | The contact's name. |
reachable (BooleanOperationFilterInput) | Whether a survey sent to this contact would arrive. |
checkedAt (DateTimeOperationFilterInput) | When the contact was last checked for reachability. |
lastReachableAt (DateTimeOperationFilterInput) | When the contact was last reachable. |
SurveyContactSortInput input
Input fields accepted by SurveyContactSortInput.
| Name | Description |
|---|---|
externalKey (SurveyContactExternalKeySortInput) | Coordinates of a contact in an external system. |
email (SortEnumType) | The contact's email address. |
name (SortEnumType) | The contact's name. |
reachable (SortEnumType) | Whether a survey sent to this contact would arrive. |
checkedAt (SortEnumType) | When the contact was last checked for reachability. |
lastReachableAt (SortEnumType) | When the contact was last reachable. |
SurveyEmployeesInput input
Which employees to pick.
| Name | Description |
|---|---|
id (ComparableEmployeeOperationFilterInput) | Only these employees. |
groupIds (ListComparableEmployeeOperationFilterInput) | Only employees in these groups. |
SurveyFilterInput input
Input fields accepted by SurveyFilterInput.
| Name | Description |
|---|---|
and ([SurveyFilterInput!]) | Matches when every one of the given filter expressions matches (logical AND). |
or ([SurveyFilterInput!]) | Matches when at least one of the given filter expressions matches (logical OR). |
id (ComparableIdTypeOperationFilterInput) | |
title (StringOperationFilterInput) | |
status (SurveyStatusOperationFilterInput) | |
createdAt (DateTimeOperationFilterInput) | |
productId (ComparableIdTypeOperationFilterInput) | |
vendorId (ComparableIdTypeOperationFilterInput) | |
vendorName (StringOperationFilterInput) |
SurveyLongTextQuestionInput input
Input fields accepted by SurveyLongTextQuestionInput.
| Name | Description |
|---|---|
key (String!) | |
title (String!) | |
description (String) | |
required (Boolean!) | |
conditions (SurveyConditionGroupInput) |
SurveyMessagesInput input
Input fields accepted by SurveyMessagesInput.
| Name | Description |
|---|---|
introduction (String!) |
SurveyQuestionInput input
Input fields accepted by SurveyQuestionInput.
| Name | Description |
|---|---|
rating (SurveyRatingQuestionInput) | |
radioGroup (SurveyRadioGroupQuestionInput) | |
yesNo (SurveyYesNoQuestionInput) | |
shortText (SurveyShortTextQuestionInput) | |
longText (SurveyLongTextQuestionInput) |
SurveyRadioGroupOptionConditionRuleInput input
Input fields accepted by SurveyRadioGroupOptionConditionRuleInput.
| Name | Description |
|---|---|
operator (SurveyRadioGroupConditionOperator!) | |
optionKey (String!) | |
questionKey (String!) |
SurveyRadioGroupOptionInput input
Input fields accepted by SurveyRadioGroupOptionInput.
| Name | Description |
|---|---|
key (String!) | |
value (String!) |
SurveyRadioGroupOtherConditionRuleInput input
Input fields accepted by SurveyRadioGroupOtherConditionRuleInput.
| Name | Description |
|---|---|
operator (SurveyRadioGroupConditionOperator!) | |
questionKey (String!) |
SurveyRadioGroupQuestionInput input
Input fields accepted by SurveyRadioGroupQuestionInput.
| Name | Description |
|---|---|
options ([SurveyRadioGroupOptionInput!]!) | |
allowOther (Boolean!) | |
key (String!) | |
title (String!) | |
description (String) | |
required (Boolean!) | |
conditions (SurveyConditionGroupInput) |
SurveyRatingBetweenConditionRuleInput input
Input fields accepted by SurveyRatingBetweenConditionRuleInput.
| Name | Description |
|---|---|
operator (SurveyRatingConditionOperator!) | |
from (Int!) | |
to (Int!) | |
questionKey (String!) |
SurveyRatingQuestionInput input
Input fields accepted by SurveyRatingQuestionInput.
| Name | Description |
|---|---|
scale (Int!) | |
key (String!) | |
title (String!) | |
description (String) | |
required (Boolean!) | |
conditions (SurveyConditionGroupInput) |
SurveyRatingValueConditionRuleInput input
Input fields accepted by SurveyRatingValueConditionRuleInput.
| Name | Description |
|---|---|
operator (SurveyRatingConditionOperator!) | |
value (Int!) | |
questionKey (String!) |
SurveyRecipientFilterInput input
Input fields accepted by SurveyRecipientFilterInput.
| Name | Description |
|---|---|
and ([SurveyRecipientFilterInput!]) | Matches when every one of the given filter expressions matches (logical AND). |
or ([SurveyRecipientFilterInput!]) | Matches when at least one of the given filter expressions matches (logical OR). |
id (ComparableIdTypeOperationFilterInput) | The recipient's identifier. |
email (StringOperationFilterInput) | The email address the survey was addressed to. |
firstName (StringOperationFilterInput) | The recipient's first name as it was at send time. |
lastName (StringOperationFilterInput) | The recipient's last name as it was at send time. |
respondedAt (DateTimeOperationFilterInput) | When the recipient completed the survey; null while there is no response. |
answers ([SurveyAnswerFilterInput!]) | Filter recipients by their answers. Entries combine as AND. |
SurveyRecipientsCountInput input
A recipient selection to count.
| Name | Description |
|---|---|
recipients (SurveyRecipientsInput!) | The people to count. |
channels ([SurveyChannelInput!]) | Count only people reachable on these channels. |
productId (ID) | The product the application users belong to. |
SurveyRecipientsInput input
Who a survey goes to.
| Name | Description |
|---|---|
employees (SurveyEmployeesInput) | Employees to include. |
applicationUsers (SurveyApplicationUsersInput) | People who use the survey's product. |
emails ([String!]) | Email addresses to include, employee or not. |
SurveyRecipientSortInput input
Input fields accepted by SurveyRecipientSortInput.
| Name | Description |
|---|---|
id (SortEnumType) | The recipient's identifier. |
email (SortEnumType) | The email address the survey was addressed to. |
firstName (SortEnumType) | The recipient's first name as it was at send time. |
lastName (SortEnumType) | The recipient's last name as it was at send time. |
respondedAt (SortEnumType) | When the recipient completed the survey; null while there is no response. |
SurveyScopeInput input
Input fields accepted by SurveyScopeInput.
| Name | Description |
|---|---|
productId (ID) | |
vendorId (ID) |
SurveyShortTextQuestionInput input
Input fields accepted by SurveyShortTextQuestionInput.
| Name | Description |
|---|---|
key (String!) | |
title (String!) | |
description (String) | |
required (Boolean!) | |
conditions (SurveyConditionGroupInput) |
SurveySortInput input
Input fields accepted by SurveySortInput.
| Name | Description |
|---|---|
id (SortEnumType) | |
createdAt (SortEnumType) |
SurveyStatusOperationFilterInput input
Input fields accepted by SurveyStatusOperationFilterInput.
| Name | Description |
|---|---|
eq (SurveyStatus) | Matches when the field value is exactly equal to the given value. |
neq (SurveyStatus) | Matches when the field value is not equal to the given value. |
in ([SurveyStatus!]) | Matches when the field value is one of the values in the given list. |
nin ([SurveyStatus!]) | Matches when the field value is none of the values in the given list. |
SurveyYesNoConditionRuleInput input
Input fields accepted by SurveyYesNoConditionRuleInput.
| Name | Description |
|---|---|
expectedValue (Boolean!) | |
questionKey (String!) |
SurveyYesNoQuestionInput input
Input fields accepted by SurveyYesNoQuestionInput.
| Name | Description |
|---|---|
yesLabel (String!) | |
noLabel (String!) | |
key (String!) | |
title (String!) | |
description (String) | |
required (Boolean!) | |
conditions (SurveyConditionGroupInput) |
Interfaces
SurveyAnswer interface
Fields defined by the SurveyAnswer interface.
| Name | Description |
|---|---|
questionKey (String!) | |
displayValue (String!) |
SurveyConditionRule interface
A rule matched against the answer to an earlier question.
| Name | Description |
|---|---|
questionKey (String!) | The earlier question whose answer is matched. |
SurveyQuestion interface
A question in a survey.
| Name | Description |
|---|---|
key (String!) | Identifies the question within the survey. |
title (String!) | The question as the recipient reads it. |
description (String) | Extra wording shown with the question. |
required (Boolean!) | Whether the question has to be answered. |
conditions (SurveyConditionGroup) | When the question is shown. |
Unions
CreatedSurvey union
Possible object types returned by the CreatedSurvey union.
Possible types: Survey
CreateSurveyError union
Possible object types returned by the CreateSurveyError union.
Possible types: FailedToCreateSurveyError
RemoveSurveyError union
Possible object types returned by the RemoveSurveyError union.
Possible types: FailedToRemoveSurveysError
SendTestSurveyError union
Possible object types returned by the SendTestSurveyError union.
Possible types: SendSurveyError
SurveyReminderError union
Possible object types returned by the SurveyReminderError union.
Possible types: SurveyNotFoundError, SurveyReminderAlreadyInProgressError, SurveyReminderNoRecipientsError
SurveyReminderStatus union
Possible object types returned by the SurveyReminderStatus union.
Possible types: SentSurveyReminderStatus, InProgressSurveyReminderStatus
SurveyScope union
Possible object types returned by the SurveyScope union.
Possible types: ProductSurveyScope, VendorSurveyScope
Enums
SurveyChannelType enum
Accepted values for the SurveyChannelType enum.
| Value | Description |
|---|---|
SLACK | |
EMAIL | |
TEAMS |
SurveyConditionGroupOperator enum
Accepted values for the SurveyConditionGroupOperator enum.
| Value | Description |
|---|---|
AND | |
OR |
SurveyContext enum
Accepted values for the SurveyContext enum.
| Value | Description |
|---|---|
LICENSE | |
USER |
SurveyRadioGroupConditionOperator enum
Accepted values for the SurveyRadioGroupConditionOperator enum.
| Value | Description |
|---|---|
EQUALS | |
NOT_EQUALS |
SurveyRatingConditionOperator enum
Accepted values for the SurveyRatingConditionOperator enum.
| Value | Description |
|---|---|
EQUALS | |
NOT_EQUALS | |
GREATER_THAN | |
LESS_THAN | |
BETWEEN |
SurveyReminderType enum
Accepted values for the SurveyReminderType enum.
| Value | Description |
|---|---|
MANUAL |
SurveyStatus enum
Accepted values for the SurveyStatus enum.
| Value | Description |
|---|---|
CREATED | |
IN_PROGRESS | |
SENT |