Browse the documentation

API Keys

Applies to: All users

Your API key lets external tools and scripts talk to your account programmatically — pulling stats, managing campaigns or zones, or feeding data in and out — without logging in through the browser each time. This guide covers what the key is for and how to look after it.

What this is#

An API key is a secret token that identifies your account to the platform's API (its programmatic interface). Anything you can do in the dashboard, an authorized integration can do with your key, scoped to your account. If you don't use integrations, you can safely ignore the key — nothing depends on it until you start using it.

When you'll use this#

Reach for your API key when you want to connect an outside tool: pull performance stats into your own spreadsheet or reporting dashboard, automate campaign or ad-zone changes, or plug in a third-party service that offers a built-in integration. You'll copy the key once into that tool's settings, and rotate it if it ever leaks.

Step by step#

Turn on API access#

  1. Open your account page → Settings tab.
  2. Find the API access option and make sure it's enabled. The key won't work until it is.
  3. On some accounts this is switched on for you; on others an administrator enables it.

Find and copy your key#

  1. On the Settings tab, locate the API key field.
  2. Reveal or view the key.
  3. Copy it and paste it into your integration's settings — never type it into a public place.

Your key and the API-access toggle live on the Settings tab.

Generate or rotate the key#

  1. On the Settings tab, choose Generate (or Rotate) API key.
  2. Confirm. A brand-new key is created and the old one stops working immediately.
  3. Update every integration that used the old key with the new value.

Options reference#

Action What it does Notes
API access (Settings toggle) Enables or disables programmatic access for your account. The key does nothing until this is on.
View key Shows your current API key so you can copy it. Treat what you copy like a password.
Generate key Creates a brand-new key. If you already had one, this replaces it.
Rotate key Generate a fresh key to retire an old one. The previous key stops working immediately.

When to rotate your key#

Rotate (regenerate) your key:

  • Whenever you suspect it has leaked — pasted somewhere public, in a screenshot, or in a support ticket.
  • When someone who had access leaves your team or company.
  • On a periodic schedule as good hygiene, even if nothing seems wrong.

Rotating instantly disables the old key, so it's the fastest way to shut out anything that shouldn't have it.

Keeping your key secret#

Treat your API key like a password — it grants access to your account.

  • Never paste it into public places: shared documents, chat channels, screenshots, support tickets, or public code repositories.
  • Store it securely — a password manager, or your integration's protected settings.
  • Give it only to tools and people you trust.
  • If it's ever exposed, rotate it immediately — generating a new key instantly disables the old one.

Keys and team accounts#

If your account uses team members, API keys stay at the account-owner level. Members act through the dashboard with their own scoped permissions rather than through a shared key. When programmatic access is needed, the owner generates and manages the key.

Example#

Connecting a reporting spreadsheet:

  1. Open Settings and confirm API access is on.
  2. View your API key and copy it.
  3. Paste it into your reporting tool's API-key field (stored in its protected settings, never in a shared sheet).
  4. The tool can now pull your stats automatically.
  5. Three months later, as routine hygiene, click Rotate, then paste the new key back into the tool.

Tips#

  • Enable API access first. A perfectly valid key still won't work if the toggle is off.
  • One key, many tools — but rotate carefully. Since all your integrations share one key, rotating means updating all of them at once.
  • Prefer a password manager over sticky notes or shared docs for storing the key.
  • Rotate the moment you're unsure. It's free and instant; a leaked key is not.

Troubleshooting#

Symptom Likely cause Fix
I can't find the API call that returns the sub-ID / zone / click ID Those aren't fetched over the API — they're delivered at click time Put the matching macro in your ad's Destination URL: see Ads & Creatives
Integration says "unauthorized" or "invalid key" API access is off, or the key was rotated Enable API access in Settings; paste the current key
A tool stopped working after I rotated It still has the old, now-disabled key Update that tool with the new key
I don't see the API key field API access isn't enabled for your account Enable it in Settings, or ask an administrator
A member wants their own key for the shared account Keys are owner-level only The owner generates the key; members use the dashboard with their own permissions