Reading KPI data

You can get Key Performance Indicator (KPI) data for each process run using the Robotiq.ai API. This lets you build your own reports and dashboards with other tools like Excel, PowerBI, Tableau, or QlikView.

What You'll Need

An Organization Admin role in Robotiq.ai.
An application set up in HQ to get a Client Secret.

How to Get KPI Data

To get KPI data, you first need to create an application in HQ. This application gives you a Client Secret, which you need for API access.

Step 1: Create a New Application

Go to the Settings tab in HQ.
Click on the Application tab.
Click the New application button.
Fill in the information in the new window.
Choose the scope kpi_read.
Give your application a name, like "KPI Custom Application".
Click Save.

Your new application will show up in the list of registered applications.

Important: Keep your Client Secret private. Handle it carefully to stop others from getting in without permission.

Step 2: Get an Access Token

Find your new application in the list.
Click the GET ACCESS TOKEN button next to your application.
Copy the access token that appears.

You'll use this token to prove who you are when you make API calls.

Using the API to Get KPI Data

Once you have an access token, you can make API calls to pull KPI data. You can use any API client, like Postman.

Example API Calls

First API call for token: Use your Client Secret and other login details to get an access token.

Second API call for KPI data: Use the access token to ask the KPI data API endpoint for information. Copy the data from the response into your application.

Need Help?

Can't find what you're looking for? Join the Robotiq Community to get help from other users and the Robotiq team.