How use API tokens to authenticate

Provided you have the API Key and Secret, (see Getting API Tokens).

Go to /oauth/token
Ensure your Base URL is set to: https://api.clarity.ai/clarity/v1.
Enter your key and secret in the key and secret fields under the BODY PARAMS section.

{
    "key": "4e56fghngn-56gf-54yt-hj78-5gfb54dfgss",
    "secret": "45t6dfhfd-drgf-23kl-1234-56gqr3hgfdgj6j-456f-gdfg-6154-dfvbdfgxcw2-3434-n24-sdf-fght5dgdfg"
}

Optional: This endpoint also has an optional portfolio field portfolioId in the JSON. If portfolioId is used API calls will be restricted to only the specified portfolio.
Press the Try it! button. This will perform the call to the API and show the response in the RESPONSE section below. The response contains JSON with your token. This token is required by the rest of the API endpoints and has an expiration time of 60 minutes.

{
  "token": "eyJhbGciOiJIUzUxMiJ9.eyJ1c2VySWQiOiI2MjhmOGEwNmY4MTQyYjE3NGFmODk2ODAiLCJjbGllbnRJZCI6IjVhZmU5ZDY2NWU1NDAwMWNkM2I3ZGM2YSIsImNsaWVudE5hbWUiOiJDbGFyaXR5IEFJIiwicm9sZSI6IlJPTEVfU1VQRVJBRE1JTiIsInRva2VuSWQiOiJQV3NxOGR2bnl6QzFCUUtRZXZ5WHlJMndoVkw0bHQ5dmdzSjJ6b09mZ3RRTWNwVkFFUCIsInBlcm1pc3Npb25zIjp7IldFQiI6WyJJTVBBQ1RfSElHSExJR0hUUyIsIlNGRFIiLCJFVV9UQVhPTk9NWV9ET1dOTE9BRCIsIkVTR19SSVNLIiwiU1VTVEFJTkFCTEVfSU5WRVNUTUVOVCIsIkVVX1RBWE9OT01ZIiwiTkVUX1pFUk8iLCJTREdfUkFfRE9XTkxPQUQiLCJTRkRSX0VFVF9SRVBPUlQiLCJTREciLCJFWFBPU1VSRV9ET1dOTE9BRCIsIlNER19SQSIsIkVYUE9TVVJFIiwiQ09OVFJPVkVSU0lFU19QUkVNSVVNIiwiRVNHX0lNUEFDVCIsIkNMSU1BVEUiXSwiQVBJIjpbIklNUEFDVF9ISUdITElHSFRTIiwiU0ZEUiIsIlZBTFVFU19BTElHTk1FTlQiLCJFU0dfUklTSyIsIlRDRkQiLCJFVV9UQVhPTk9NWSIsIk5FVF9aRVJPIiwiTkVUX1pFUk9fUkFXX0RBVEEiLCJTREciLCJQUk9EVUNUX0lNUEFDVCIsIkVYUE9TVVJFIiwiQ0xJTUFURSIsIkVTR19JTVBBQ1QiXX0sInNjb3BlcyI6WyIvcHVibGljLyoqIiwiLyoqIl0sImNsYXJpdHlPcmdJZCI6IjAxRkY1NDNTRVo4UVhGWFJISDJEWjlFWFA3IiwiaXNzIjoiY2xhcml0eV9hcGkiLCJqdGkiOiI3YzVjNTExZi1mNWU2LTQ1YzMtYjMyMi0yNTk0ZDJhNDI2ODciLCJpYXQiOjE2OTc0NjcwNDgsImV4cCI6MTY5NzQ3MDY0OH0.zsomP_Yq3NGM5BRQHe5ktVOy3KKpeoyTEBsA_PGAEJWmE7Vvzvay6y4IgXr8j9Rr2R0Lk9751bMkn5pNMZNvvg"
}

Copy the Bearer token. Note: you only need the token itself. For example:

   eyJhbGciOiJIUzUxMiJ9.eyJ1c2VySWQiOiI2MjhmOGEwNmY4MTQyYjE3NGFmODk2ODAiLCJjbGllbnRJZCI6IjVhZmU5ZDY2NWU1NDAwMWNkM2I3ZGM2YSIsImNsaWVudE5hbWUiOiJDbGFyaXR5IEFJIiwicm9sZSI6IlJPTEVfU1VQRVJBRE1JTiIsInRva2VuSWQiOiJQV3NxOGR2bnl6QzFCUUtRZXZ5WHlJMndoVkw0bHQ5dmdzSjJ6b09mZ3RRTWNwVkFFUCIsInBlcm1pc3Npb25zIjp7IldFQiI6WyJJTVBBQ1RfSElHSExJR0hUUyIsIlNGRFIiLCJFVV9UQVhPTk9NWV9ET1dOTE9BRCIsIkVTR19SSVNLIiwiU1VTVEFJTkFCTEVfSU5WRVNUTUVOVCIsIkVVX1RBWE9OT01ZIiwiTkVUX1pFUk8iLCJTREdfUkFfRE9XTkxPQUQiLCJTRkRSX0VFVF9SRVBPUlQiLCJTREciLCJFWFBPU1VSRV9ET1dOTE9BRCIsIlNER19SQSIsIkVYUE9TVVJFIiwiQ09OVFJPVkVSU0lFU19QUkVNSVVNIiwiRVNHX0lNUEFDVCIsIkNMSU1BVEUiXSwiQVBJIjpbIklNUEFDVF9ISUdITElHSFRTIiwiU0ZEUiIsIlZBTFVFU19BTElHTk1FTlQiLCJFU0dfUklTSyIsIlRDRkQiLCJFVV9UQVhPTk9NWSIsIk5FVF9aRVJPIiwiTkVUX1pFUk9fUkFXX0RBVEEiLCJTREciLCJQUk9EVUNUX0lNUEFDVCIsIkVYUE9TVVJFIiwiQ0xJTUFURSIsIkVTR19JTVBBQ1QiXX0sInNjb3BlcyI6WyIvcHVibGljLyoqIiwiLyoqIl0sImNsYXJpdHlPcmdJZCI6IjAxRkY1NDNTRVo4UVhGWFJISDJEWjlFWFA3IiwiaXNzIjoiY2xhcml0eV9hcGkiLCJqdGkiOiI3YzVjNTExZi1mNWU2LTQ1YzMtYjMyMi0yNTk0ZDJhNDI2ODciLCJpYXQiOjE2OTc0NjcwNDgsImV4cCI6MTY5NzQ3MDY0OH0.zsomP_Yq3NGM5BRQHe5ktVOy3KKpeoyTEBsA_PGAEJWmE7Vvzvay6y4IgXr8j9Rr2R0Lk9751bMkn5pNMZNvvg

Use the token in your consequent requests into the Authorization Header:

'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJ1c2VySWQiOiI2MjE3ODg2NTBmZDVjMjdhMzVjNGVlZmUiLCJjbGllbnRJZCI6IjVhZmU5ZDY2NWU1NDAwMWNkM2I3ZGM2YSIsImNsaWVudE5hbWUiOiJDbGFyaXR5IEFJIiwicm9sZSI6IlJPTEVfVVNFUiIsInRva2VuSWQiOiJrZHVoczJ5SDVzWVNITEpQVkhldXhNRlJXMWpSaGZaTXFJTGVGREx4WVlsNUJUV25UcCIsInBlcm1pc3Npb25zIjp7IldFQiI6WyJJTVBBQ1RfSElHSExJR0hUUyIsIlNGRFJfUkFXX0RBVEFfRVhQT1JUIiwiU0ZEUiIsIkVVX1RBWE9OT01ZX0RPV05MT0FEIiwiU1VTVEFJTkFCTEVfSU5WRVNUTUVOVCIsIkVTR19SSVNLIiwiRVVfVEFYT05PTVkiLCJORVRfWkVSTyIsIlNER19SQV9ET1dOTE9BRCIsIlNGRFJfRUVUX1JFUE9SVCIsIlNERyIsIkVYUE9TVVJFX0RPV05MT0FEIiwiU0RHX1JBIiwiQ09OVFJPVkVSU0lFU19QUkVNSVVNIiwiRVhQT1NVUkUiLCJDTElNQVRFIl0sIkFQSSI6WyJJTVBBQ1RfSElHSExJR0hUUyIsIlNGRFIiLCJWQUxVRVNfQUxJR05NRU5UIiwiVENGRCIsIkVTR19SSVNLIiwiRVVfVEFYT05PTVkiLCJORVRfWkVSTyIsIk1JRklEX0ZVTEwiLCJORVRfWkVST19SQVdfREFUQSIsIlNERyIsIlNER19SQSIsIlBST0RVQ1RfSU1QQUNUIiwiRVhQT1NVUkUiLCJNSUZJRF9DTEFTU0lGSUVSIiwiQ0xJTUFURSIsIkVTR19JTVBBQ1QiXX0sInNjb3BlcyI6WyIvcHVibGljLyoqIiwiLyoqIl0sImNsYXJpdHlPcmdJZCI6IjAxRkY1NDNTRVo4UVhGWFJISDJEWjlFWFA3IiwiaXNzIjoiY2xhcml0eV9hcGkiLCJqdGkiOiJkZjgzNTZiMC1kMzM4LTQ1Y2YtODMyZS1lNWY1NThmOWU2MGIiLCJpYXQiOjE3MDU0MDkwODUsImV4cCI6MTcwNTQxMjY4NX0.DSH-Cqg5_XlAQO-kZxVmGO0x7LWRlksk9Hi7xFNprmmnp_0kDC3jQLN4nkQLmSzWamASE6b7DDKcFdu8dCGLsQ'