API: Glossary
Key terms used throughout the Insight API and documentation.
- Anonymity (AnonOk)
Insight protects individual respondent privacy. When a group has too few respondents to guarantee anonymity, results are hidden. The anonOk field indicates whether results are visible (true) or suppressed (false).
- API Token
A credential that grants access to the Insight API. Tokens are created by administrators in Insight and have specific permissions that control which endpoints they can access (e.g., organization data, survey data, results).
- Attribute
A configurable, organization-specific property attached to users (e.g., role, location, employment type). Attribute names can be retrieved in different languages via languageCode.
- Category
A classification for groups. Common categories include "team" and "summary". Categories help organize groups into meaningful layers of your organizational hierarchy.
- CX (Customer Experience)
A company type in Insight focused on customer feedback rather than employee engagement. CX-type companies have access to individual response data via GET /api/public/surveys/{id}/responses; non-CX companies only see aggregated results.
- External ID
An optional identifier you assign to groups to match them with entities in external systems (e.g., team IDs in your HR system). Useful for automated synchronization.
- Group
An organizational unit in Insight — typically representing a team, department, office, or other structural entity. Groups belong to a category (e.g., "team", "department") and can have an external ID for mapping to other systems.
- Index
A high-level engagement theme that aggregates multiple questions into a single score. Examples include leadership, autonomy, meaningful work, and team spirit. Each organization enables the indexes relevant to them.
- Language Code
A two-letter code following the ISO 639-1 standard, used to request localized content.
Examples: en (English) sv (Swedish) da (Danish) no (Norwegian) fi (Finnish)
- Permissions
API tokens have granular permissions:
- Organization — access to group data
- Survey — access to survey listings
- Results — access to survey results, indexes, and questions
- Organisation.EditGroup.CreateUser — required to create users via
POST /api/public/users - Organisation.EditUser.Update — required to update users via
PUT /api/public/users - Organisation.EditUser.Delete — required to soft-delete users via
DELETE /api/public/users
- Responses
Individual answers to a survey, exposed only for customer-experience (CX) surveys. Each response includes free-text, number, and date answers, plus the respondent's groups and attributes at the time of submission. Free-text answers may include tonality classification.
- Results
Aggregated survey responses. Results are available per group, broken down by index and question. Results are only available for surveys that are closed and calculated.
- Survey
A questionnaire sent to employees to measure engagement. Surveys can be:
- One-time — sent once
- Recurring — automatically repeated on a schedule
Surveys go through the following statuses: scheduled, ongoing (open for responses), and finished (closed and calculated).
- Tonality
A sentiment classification applied to free-text answers in CX surveys. Each free-text answer can have an overall tonality (Negative, Neutral, Positive, or Unknown) and per-category tonalities. Available freetext categories can be retrieved via GET /api/public/freetext-categories.
- Question
An individual item in a survey. Questions can be:
- Standard — provided by Insight, used across organizations
- Company-specific — custom questions added by your organization
Questions are displayed in the language you specify via the languageCode parameter.