Data Analytics API - How to Generate my API Key

Shivani Panchal Updated by Shivani Panchal

The API key provides direct access to your Performance & Talent data and should be handled carefully. Only one active API key is allowed per organisation, so it's essential to coordinate with colleagues who may need access.

Steps to Generate an API Key

  1. Navigate to the Admin Setting > Analytics section and select Configure API Keys.
  2. Select the Add API Key
  3. You will be prompted to give the API key a name, then select 'Add'.
  4. This will generate your API Key. The text will be protected; select the 'eye' icon to make it visible. Make sure to select 'copy' and save it for future use, as you won't be able to view it again after this initial screen.

Using the API Key

Once created, you can use the key with dashboarding tools like Excel, Power BI, or Tableau to extract your data. If you need to create a new key, navigate back to this screen, delete the current key, and create a new one.

Note: Any existing data extracts or dashboards will need to be updated with the new key to continue working.

For more technical details, visit our Swagger Hub.

Was this article useful?

Analytics Overview (Additional Module)

Contact