For customers with access to the Triple Whale API, making API requests just got a lot easier. You can now create, monitor, and manage API Keys directly inside of Triple Whale.
For documentation on available endpoints and examples for using the API, visit the following resources:
Creating API Keys
Visit the API Keys Page
To create a new API key, first navigate to the API Keys page inside of the Triple Whale App. The page can be found inside of the settings menu or by navigating to https://app.triplewhale.com/api-keys.
Generate a new API Key
If you have not yet created any API keys, click the "Generate an API Key" button to begin to configure your first API key.
Give your API key a description that matches your intended use for the API key. This description will be displayed later so you can keep track of the purpose for each of your keys.
Select the intended scopes for the API key. Each scope is tied to a specific endpoint:
TW Metrics: Read - Select this scope for pulling data from the Summary Page
TW Attribution: Read - Select this scope for pulling customer journey data from the Pixel
With a proper description and scope configuration, click "Generate" to create a new key.
Once your key is generated, it will be displayed in a popup. Be sure to copy it and store it somewhere safe. Once this popup is closed, you will no longer be able to see the full key again.
Managing API Keys
After you have generated one or more API keys, they will display in the table on the API keys page. Here you will be able to see the description and scope, as well as the last time the key was used to make an API call.
If you no longer need a key or suspect it has been leaked for any reason, you can revoke access by simple selecting "Revoke" and confirming. This action is irreversible.
Testing Your Key
To test your key, make the following curl request from your terminal. You should receive a 200 response:
curl https://api.triplewhale.com/api/v2/users/api-keys/me -H "x-api-key: <PUT_API_KEY_HERE>"