Skip to main content

Managing Klar Data API Key Access

Written by Valentine Strunz-Happe

Klar’s Public API enables programmatic access to your attribution, marketing, and revenue metrics. This guide is for Account Owners and Admins to govern how their team accesses this data securely.

For developers building integrations, please refer to the Technical Documentation for full endpoint specifications:

Step 1: Setting up Team Permissions

Before anyone can manage keys, they need the right access.

  1. Navigate to your 'Account Settings' > 'Users' > 'Manage access' section.

  2. Create or edit a role to include the ‘Settings’ > 'API Key Management' permission.

  3. Assign this role to the team members (e.g., Data Engineers, Analysts) who need to manage (generate or revoke) API keys.

Note: Only users with the Account Owner role or the 'API Key Management' permission can view the API Keys dashboard.

Step 2: Generating & Managing API Keys

  1. Navigate to Account Settings > API Keys.

  2. Click 'Create New Secret Key'.

  3. Naming: Give your key a clear, descriptive name (e.g. 'Tableau Integration').

  4. Scoping: Define the permissions this key will have (Attribution, Marketing, Revenue & Profit). Tip: Follow the principle of least privilege - only select the scopes the specific integration requires.

  5. Important Security Warning: Once you click 'Create', the raw API key will be displayed only once. Copy and store it immediately in your secure password manager or environment variable system. It cannot be recovered if lost.

Step 3: Key Lifecycle & Security

  • Revoking: If an integration is no longer needed, revoke the key immediately to close that access point.

  • Employee Offboarding: API keys are bound to the creator. If a user account is deleted or suspended, all associated keys are automatically revoked (after a confirmation prompt)

Troubleshooting & FAQ

  • Why can't I see the API Keys tab? Ensure you are an Account Owner or have a role with the 'API Key Management' permission enabled.

Technical Documentation

For developers building integrations, please refer to the Technical API Documentation for full endpoint specifications.

Did this answer your question?