Open API Overview (Admin)
.Category: Hive's Open API | Type: Overview | Part 1 of 2 on Hives Open API
What you'll find in this guide:
Overview of the Hive Open API
The Hive Open API lets your IT or data team pull data directly from Hive into external business intelligence tools — such as Power BI or a central data warehouse — without the need for manual CSV exports.
Why it matters
As HR teams become more data-sophisticated, there's a growing need to see employee voice data alongside business metrics like headcount, attrition, and revenue. The Open API makes this possible — replacing a manual, error-prone export process with an automated, real-time data pipeline.
This enables your organisation to move from reporting engagement scores in isolation to demonstrating the connection between employee experience and business outcomes — the kind of evidence that resonates at board level.
Common use cases include:
- Overlaying engagement scores with operational data (revenue, productivity, absenteeism) to identify correlations
- Building a single executive dashboard that combines Hive metrics with company KPIs
- Monitoring attrition risk early by tracking engagement trends alongside turnover data
- Removing the monthly overhead of manual data exports for HR and analytics teams
What data is available
The API returns the same data visible inside the Hive platform — it doesn't expose anything additional, and it applies the same confidentiality thresholds your organisation has already configured. All responses are in JSON format.
|
Data type |
What you can retrieve |
|
Attributes & segments |
Demographic attributes, segment IDs, and date reporting buckets — used to filter other requests |
|
Surveys |
Survey name, type, status, and date range |
|
Survey questions |
All questions within a survey, including question type and response options |
|
Question statistics |
Response counts, average scores, score distributions, and favourable scores |
|
Metrics |
Engagement Index, eNPS, average score, and any custom metrics — filterable by segment or date |
|
Key Drivers |
Driver questions, influence scores, coefficients, and action labels |
|
Heatmap data |
Flat list of scores by question and segment |
|
Open Door submissions |
Anonymous text submissions, filterable by date and segment. No employee is ever identified |
|
Hive Fives (Recognition) |
Peer-to-peer recognition events, including category, recipient, and sender attributes |
Confidentiality by design
The Open API is built around Hive's existing confidentiality model — it doesn't create new privacy risks.
- All data is aggregated. No individual-level responses, names, or email addresses are ever returned
- If a segment has fewer responses than your organisation's configured confidentiality threshold, the API returns a null value for that group rather than suppressing silently
- Open Door submissions are completely stripped of employee identifiers
- For Hive Fives, if an employee has marked their recognition as private, the recognition text is returned as null — the metadata count is retained for reporting purposes, but the content is protected
Who can set this up? The user configuring the API must have the Administrator of Integrations permission in Hive. Only users with this role can access Service Accounts, API keys, and API Logs.
|
◀ Start Back to contents |
Next ▶ Step-by-Step Admins & IT - Hive Open API Guide |
🎓 Other Useful Information
📖
Require further technical assistance? Contact Our Support Team