Skip to content
English
Contact us
  • There are no suggestions because the search field is empty.

API: Glossary

Key terms used throughout the Insight API and documentation.

 

- 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.

- Category

A classification for groups. Common categories include "team" and "summary". Categories help organize groups into meaningful layers of your organizational hierarchy.

- 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).

- 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.

- 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.

- 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.

- 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).

- 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.

- 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).

- Permissions

API tokens have granular permissions:

  • Organization — access to group data
  • Survey — access to survey listings
  • Results — access to survey results, indexes, and questions

- 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)