Skip to main content

Survey

The Survey object contains questions and possibly other surveys in a tree

type Survey {
allowlist: [User]
anonymous: Boolean
archiveTime: DateTime
assessmentOptions: [SurveyAssessmentOptions] @deprecated
assessmentResultsDisplayHr: [SurveyAssessmentResultsDisplay] @deprecated
assessmentResultsDisplayJs: [SurveyAssessmentResultsDisplay] @deprecated
children: [Survey]
closeTime: DateTime
company: Company
companyOnly: Boolean
companyTheme: CompanyTheme
createTime: DateTime
creditCost: Int
deleteTime: DateTime
draftTime: DateTime
experience: Experience
feedbackAve: Float
feedbackCount: Int
feedbackMax: Float
feedbackMin: Float
feedbackStd: Float
headSurvey: Survey
hrUiData: String
id: Int
identityTypes: [SurveyIdentityType]
industry: Industry
integration: SurveyIntegration
isValidQueryParams: Boolean
jobType: JobType
language: String
linkedAssessments: [SurveyAssessmentLink]
name: String
next: Survey
noResponseResults: Boolean
numberOfQuestions: Int
occupations: [Occupation]
optional: Boolean
order: Int
owner: User
owners: [User]
parent: Survey
percentageThatWillComplete: Int
previous: Survey
profile: SurveyProfile
publishTime: DateTime
qrCodeUrl: String
questions: [SurveyQuestion]
randomiseQuestions: Boolean
rankTime: DateTime
response(
userId: Int
): Response
responseFinishedCount: Int
responseLatestTime: DateTime
responseList(
offset: Int
limit: Int
): [Response]
responsePercentiledCount: Int
responseArchivedCount: Int
responseNotificationsEnabled: Boolean
responseNotificationsFrequency: ResponseNotificationFrequency
responseNotificationsReceivers: [User]
responseRankedCount: Int
responseScoredCount: Int
responseStartedCount: Int
responseTimeoutCount: Int
responseTotalCount: Int
results: [SurveyResult]
status: SurveyStatus
subjectCan: SubjectCan
surveyPurpose: SurveyPurpose
surveySubscriptionLevel: SubscriptionLevelType
surveyType: SurveyType
thankyouPage: Page
timeout: Int
timeToComplete: Int
updateTime: DateTime
url: String
urlPath: String
welcomePage: Page
}

Fields

Survey.allowlist ● [User] list object

List of Users allowed to respond to this survey

Survey.anonymous ● Boolean scalar

Survey accepts anonymous responses. Currently not supported.

Survey.archiveTime ● DateTime scalar

When the Survey was archived

Survey.children ● [Survey] list object

Child surveys of this survey

Survey.closeTime ● DateTime scalar

When this survey was closed

Survey.company ● Company object

Company owning this survey

Survey.companyOnly ● Boolean scalar

Survey is for internal company use only

Survey.companyTheme ● CompanyTheme object

Theme to use when displaying this survey to respondents

Survey.createTime ● DateTime scalar

When this survey was created

Survey.creditCost ● Int scalar

Cost in credits for the survey

Survey.deleteTime ● DateTime scalar

When this survey was deletet, state changed to deleted

Survey.draftTime ● DateTime scalar

When the survey state was set to draft

Survey.experience ● Experience object

Experience range for this survey

Survey.feedbackAve ● Float scalar

Average feedback score

Survey.feedbackCount ● Int scalar

Number of feedback responses

Survey.feedbackMax ● Float scalar

Max feedback score

Survey.feedbackMin ● Float scalar

Min feedback score

Survey.feedbackStd ● Float scalar

Standard deviation of feedback scores

Survey.headSurvey ● Survey object

Head survey of this survey tree

Survey.hrUiData ● String scalar

Cache for HR UI data

Survey.id ● Int scalar

ID of this survey

Survey.identityTypes ● [SurveyIdentityType] list enum

List of IdentityTypes support by this survey

Survey.industry ● Industry object

Industry target for this survey

Survey.integration ● SurveyIntegration enum

Integration used in this survey

Survey.isValidQueryParams ● Boolean scalar

If the query-params passed in the URL when requesting this survey are valid

Survey.jobType ● JobType object

JobType target for this survey

Survey.language ● String scalar

Language used in this survey

List of assessments linked to this survey with linking options

Survey.name ● String scalar

Name of this survey

Survey.next ● Survey object

Next survey in the tree

Survey.noResponseResults ● Boolean scalar

No results for survey

Survey.numberOfQuestions ● Int scalar

Number of questions to show to the respondent

Survey.occupations ● [Occupation] list object

Occupations of this survey.

Survey.optional ● Boolean scalar

If this survey is optional (can be skipped)

Survey.order ● Int scalar

Order of this survey in the tree

Survey.owner ● User object

Owner of this survey

Survey.owners ● [User] list object

Owners sharing this survey. Currently unsupported.

Survey.parent ● Survey object

Parent of this survey

Survey.percentageThatWillComplete ● Int scalar

Percentage of applicants that will complete the survey

Survey.previous ● Survey object

Previous survey in the tree

Survey.profile ● SurveyProfile object

Profile for this survey

Survey.publishTime ● DateTime scalar

When this survey was published

Survey.qrCodeUrl ● String scalar

URL to the QR code of this survey

Survey.questions ● [SurveyQuestion] list object

Questions in this survey

Survey.randomiseQuestions ● Boolean scalar

Should random questions be chosen per respondent

Survey.rankTime ● DateTime scalar

When the survey was last ranked

Survey.response ● Response object

Reponse for current user or UserID

Survey.response.userId ● Int scalar

Get response for this UserID

Survey.responseFinishedCount ● Int scalar

Number of finished responses

Survey.responseLatestTime ● DateTime scalar

When the latest response was received

Survey.responseList ● [Response] list object

Reponses to this survey

Survey.responseList.offset ● Int scalar

Offset into response list

Survey.responseList.limit ● Int scalar

Limit number of responses in the list

Survey.responsePercentiledCount ● Int scalar

Number of responses with calculated percentile

Survey.responseArchivedCount ● Int scalar

Number of archived responses

Survey.responseNotificationsEnabled ● Boolean scalar

Enable/Disable email notification for survey response

Survey.responseNotificationsFrequency ● ResponseNotificationFrequency enum

Frequency at which response status will be shared

Survey.responseNotificationsReceivers ● [User] list object

Users to whom email notification should be sent

Survey.responseRankedCount ● Int scalar

Number of ranked responses

Survey.responseScoredCount ● Int scalar

Number of responses with calculated score

Survey.responseStartedCount ● Int scalar

Number of started responses

Survey.responseTimeoutCount ● Int scalar

Number of timed out responses

Survey.responseTotalCount ● Int scalar

Total number of responses

Survey.results ● [SurveyResult] list object

Aggregate survey results. Currently not supported.

Survey.status ● SurveyStatus enum

Status of this survey

Survey.subjectCan ● SubjectCan object

SubjectCan options for this survey

Survey.surveyPurpose ● SurveyPurpose enum

The purpose of this survey

Survey.surveySubscriptionLevel ● SubscriptionLevelType enum

SubscriptionLevel required to access this survey. Currently unsupported.

Survey.surveyType ● SurveyType enum

The type of this survey

Survey.thankyouPage ● Page object

This surveys thankyou page

Survey.timeout ● Int scalar

Timeout in seconds for this survey

Survey.timeToComplete ● Int scalar

Time to complete this survey tree

Survey.updateTime ● DateTime scalar

When this survey was updated

Survey.url ● String scalar

Full URL to this survey

Survey.urlPath ● String scalar

URL path (without the domain) to this survey

Survey.welcomePage ● Page object

This surveys welcome page

Show deprecated

Returned By

survey query ● surveyRoot query ● surveyTreeList query

Member Of

Assessment object ● Response object ● Survey object ● SurveyAddQuestions object ● SurveyAssessmentResultsDisplay object ● SurveyClearLinkedAssessments object ● SurveyClearProfile object ● SurveyClearQuestions object ● SurveyClearThankyouPage object ● SurveyClearWelcomePage object ● SurveyCreate object ● SurveyCreateList object ● SurveyCreateTree object ● SurveyDuplicate object ● SurveyList object ● SurveyRemoveLinkedAssessment object ● SurveyResult object ● SurveyUpdate object ● SurveyUpdateList object ● SurveyUpdateTree object