How to manage your API keys

Any user with a Supermetrics API subscription can generate an API key on the Supermetrics Hub.

Instructions

Create API keys

1. On the Supermetrics Hub, click your avatar in the top-right corner.

2. Select API keys.

3. If you have a Supermetrics API subscription, you’ll see a list of API keys and a button to prompt you to create a new API key.

4. To create a new API key, click Create API key.

5. Select either the user key or query key. Make sure to select the correct key type!

   • User key is for personal use and can be assigned permissions and associated with a user.

   • Query key which is just for fetching data and will be visible to your whole team

6. Give your API key a name and set permissions and IP restrictions as necessary.

7. Click Create API key.

8. Once created, click Copy API key to copy the key to a safe location.

   Be sure to copy your API key

   Make sure you copy your API key at this point as you won’t be able to access this key later.

   Please note: Currently only account admins and account owners can create API KEYS

View API key details

1. On the Supermetrics Hub, click your avatar in the top-right corner.

2. Select API keys

3. Click the 3-dot menu at the end of the key row.

4. Click View details. You can edit the details as you like.
   Note that the API key details don’t show the API key.

Disable an API key

1. On the Supermetrics Hub, click your avatar in the top-right corner.

2. Select API keys.

3. Click the 3-dot menu at the end of the key row.

4. Click Disable key.

   Disabling API keys is irreversible

   Once you disable an API key it will be removed immediately. This is an irreversible action.

5. Enter the API key ID, and click Disable API key to confirm.