π Nomenclature
This section defines key terms used throughout the Questback Public API documentation to ensure consistency and clarity.
π Domain-Specific TerminologyCopied!
-
Quest
A quest is a project container that includes components such as invitations, questions, responses, and reports. It represents the core unit for survey distribution and data collection. -
Question
A question is a prompt designed to collect specific information, opinions, or feedback from respondents. Questions support both quantitative and qualitative analysis, aligning with the overall objectives of the quest. -
Alternative
An alternative (or choice) is one of the selectable options associated with a specific question. -
Respondent
An individual invited to participate in a quest. Respondents provide answers that contribute to the collected dataset used for analysis or decision-making. They may be targeted based on predefined criteria. -
Invitation
A formal request sent to a respondent, inviting them to participate in a quest. Invitations typically include:- Purpose: A brief explanation of the surveyβs goal.
- Instructions: How to access and complete the survey.
- Access Details: A unique URL or code securing access to the quest.
-
Response
The data submitted by a respondent as answers to a quest's questions. Each response is tied to a specific invitation. -
RespondentData
Supplemental data associated with a respondent, often imported from a customer system. It is added at the time of invitation and may be used for:- Personalizing invitations, questions, or notifications
- Reporting and segmentation
- Auto-populating fields in the survey
Once the respondent completes a quest, their RespondentData is copied to the resulting response record.
-
RespondentDataField / Field
A predefined field in a quest used to store respondentData (e.g., department, role). These fields can optionally be displayed to the respondent during the survey. Note that the values attached to the invitation can differ from those stored with the response. -
Language Code
A standardized identifier used to define the language of a quest or invitation. Follows the BCP 47 format (e.g.,en-GB
,sv-SE
). -
OrderNumber
Indicates the position or order of an item (e.g., the sequence of questions or alternatives within a question).
βοΈ Generic API TerminologyCopied!
These terms are commonly used across most modern APIs and are not specific to Questback.
-
Endpoint
A specific URL path in the API used to access a resource or perform an operation. -
Request
An HTTP message sent by a client (e.g., your application) to perform an action via the API. -
Response
The data returned by the server after processing an API request. -
Parameter
A value supplied by the client to influence an API operation. Parameters can be included in the query string, URL path, headers, or request body.