Step by Step Guide: Admins & IT - Hive Open API

[ADD IN STORYLANE IF AVAILABLE]

Part 1: admin setup

Step 1 - Create a service account

A service account is not a person — it has no password and cannot log into Hive. It's a named account your API key is attached to, so you can identify where requests are coming from and manage access cleanly.

1. Go to Settings and select Service Accounts
2. Click Create service account
3. Give it a descriptive name — for example, PowerBI Dashboard or HR Analytics Team — and save

You can create multiple service accounts, one per tool or team. Each can have its own API keys with different permission sets.

Step 2 - Generate an API key

1. From the Service Accounts page, click on the account you just created (or select Manage API keys)
2. Click Create API key
3. Select the permissions for this key — these control which data types it can access. If you're unsure, you can grant full access initially and restrict later
4. Click Create, then copy the API key immediately and store it in a secure location

Part 2: Connecting to your BI tool

This section is for the IT or data analyst completing the integration.

Step 1 - Open the API documentation

Before building any integration, use Hive's built-in API documentation to explore endpoints and test requests live in your browser.

• From the Service Accounts page, click View API docs

1. Enter your tenant slug — this is the subdomain of your Hive URL (e.g. if your URL is yourcompany.hive.hr, your slug is yourcompany)
2. Paste your API key into the Authentication field — the documentation will use it automatically for all test requests in that session

Note: If you refresh the browser, you will need to re-enter your tenant slug and API key. They are not saved between sessions.

Step 2 - Test your connection

Each endpoint in the documentation has a Test request button. Use this to check what data looks like before writing any integration code.

• A 200 status means the request was successful
• A 401 status means unauthorised — usually an incorrect or missing API key

Step 3 - Connect to Power BI

1. In Power BI for example, select Get Data > From Web
2. Paste the Hive endpoint URL (e.g. api.hive.hr/v1/heatmap/{survey_id})
3. When prompted for authentication, select Web API or Advanced and enter your API key as an HTTP request header: Authorization: Bearer [Your_Key]
4. Use Power Query to clean and shape the response — Hive returns flattened JSON to minimise transformation work

Step 4 - Build your first view

Once connected, use the Attributes endpoint first to retrieve segment IDs, which you'll need to filter data in all other endpoints. Then use the Surveys endpoint to retrieve survey IDs for pulling scores, metrics, and Key Drivers.

Available endpoints