Create and revoke API keys

Create a full-access or reporting-only API key for scripts and BI tools, copy it once, and revoke it. Learn what ends a key early.

An API key lets a script or a reporting tool call LtvAdx as you, without your password. Use a reporting-only key for dashboards and exports. Use a full-access key only for an integration that has to change things.

Before you start

Your email must be verified. A key can't be created in a sandbox account that has not verified its email. See Create your account.
A key belongs to you as a person, not to the account. It does what your seat can do, and it stops when your access ends.
A key acts on your own account. It does not act on another account where you only hold a seat.
You can hold 10 live keys. Revoke one to make another.

Create a key

Open Account settings and select the API Keys tab.
Type a name that says what the key is for, such as "Weekly report export".
Choose the scope. Full access does everything you can do in the dashboard. Reporting only reads reports and report exports, and nothing else.
Select Create Key.
Copy the key shown in the green box and store it somewhere safe. It is shown once and can't be shown again.
Select Done.

A key lasts 365 days. The list shows the name, the start and last four characters, when it was created, when it was last used and when it expires.

Use a key

Send it as a bearer token in the Authorization header of each request. See Getting started for an example and Reporting overview for the reports.

Authorization: Bearer YOUR_KEY

A reporting-only key is refused on anything except reading reports. The reply says "This API key can only read reports".

Revoke a key

Open the API Keys tab.
Find the key and select Revoke.

The key stops working at once. A revoked key stays in the list, marked Revoked.

What ends a key early

You revoke it.
You change or reset your password. This revokes all your keys, reporting-only keys included.
Your account is suspended.
Your only seat on the account ends. The key then answers "This API key's account no longer has access".

If something goes wrong

"Verify your email first". Confirm your email, then create the key.
"You have 10 active API keys. Revoke one to create another." Revoke a key you no longer use.
"Invalid, expired, or revoked API key". The key was revoked, has expired, or was copied wrongly. Create a new one.
You lost the key. It can't be shown again. Revoke it and create a new one.