API: Use Cases
The Insight API enables a wide range of integrations. Below are common scenarios to help you understand what's possible.
BI Dashboard Integration
Goal: Display engagement data alongside other business metrics in tools like Power BI, Tableau, or Looker.
How it works:
- Use
GET /api/public/surveysto find completed surveys - Pull results with
GET /api/public/surveys/{id}/results - Map index scores to your dashboard visualizations
- Use
GET /api/public/groupsto match results to your organizational structure
Value: Get a unified view of engagement alongside revenue, retention, and other KPIs — without switching between tools.
Custom Reporting & Exports
Goal: Build tailored reports that go beyond what Insight's built-in reports offer.
How it works:
- Fetch questions and indexes with localized names in your preferred language
- Pull survey results filtered by specific groups or indexes
- Transform and format data to match your reporting needs
Value: Create reports tailored to specific stakeholders — board presentations, team-level summaries, or cross-department comparisons.
HR System Synchronization
Goal: Keep your organizational structure in Insight up to date with your HR system (e.g., SAP SuccessFactors, Personio, HaileyHR).
How it works:
- Use
GET /api/public/groupsto read the current group structure - Compare with your HR system's organizational data
- Identify differences that need manual attention
Value: Ensure surveys always target the right people and results map to the correct teams — without manual data entry.
Automated Engagement Monitoring
Goal: Trigger alerts or workflows based on engagement trends.
How it works:
- Periodically poll
GET /api/public/surveysfor newly completed surveys - Fetch results and compare against previous periods or thresholds
- Trigger notifications (email, Slack, Teams) when scores drop or improve significantly
Value: Proactive engagement management — surface issues before they become problems.
Multi-System Data Correlation
Goal: Correlate engagement data with other people metrics (turnover, sick leave, performance).
How it works:
- Pull engagement results per group via the API
- Match groups to organizational units in your other systems using
externalId - Combine datasets for analysis
Value: Understand the relationship between engagement and business outcomes with hard data.
Getting started
Ready to build? See the Getting Started guide to make your first API call.