Create an API Key

What Are API Keys?

API keys let you authenticate with the DigitalPilot API so you can programmatically access visitor data, reports, and other features from your own applications, scripts, or integrations. Each key has a name so you can tell them apart (e.g. "Production", "Internal tool").

Who Can Create API Keys?

Only admins for a tag can generate API keys. If you don't see the option to generate a key, ask an admin on your team to create one for you or to change your role.

Step-by-Step Instructions

1. Go to API Keys

• Log in to your DigitalPilot account.
• In the left-hand menu, go to Settings.
• Click API Keys in the settings navigation.

2. Generate a New API Key

• Click Generate a new API key.
• In the modal, enter a name for your key (e.g. "CRM integration", "Reporting script"). This helps you identify the key later.
• Click Generate.

3. Copy and Save Your Key

After the key is generated, it will be shown once in the modal. Copy the key immediately and store it somewhere safe (e.g. a password manager or secure env variable). For security reasons, DigitalPilot cannot show the full key again—if you lose it, you'll need to create a new key and revoke the old one.

Click Copy in the modal to copy the key, then OK to close. The new key will appear in the Your API Keys list with its name and creation date.

Using Your API Key

Use the key in the Authorization header when calling the DigitalPilot API (e.g. Authorization: Bearer YOUR_API_KEY). For full endpoint documentation, see the API Reference (linked from the API Keys page).

Managing and Deleting Keys

You can view all your API keys on the API Keys page (key values are masked for security). If a key is compromised or no longer needed, delete it from the list—that key will stop working immediately. You can then create a new key if needed.