API Keys
Create a key so another tool can read your Fullmetrix reports, keep it safe and revoke it when you no longer need it.
An API key is a password meant for software. It lets an external tool read your Fullmetrix reports without using your personal account. You will need one for three uses.
- The Looker Studio connector, to build your own Google dashboards.
- The public API, so a developer can pull your numbers into other software, a spreadsheet or a BI tool.
- The MCP server, to query your data from a compatible AI assistant.
A key gives read access to the reports of the whole organization, all stores included. It cannot change your settings or your data.
To manage your keys, click Settings in the sidebar, then the API Keys tab.
Create a key
Open key creation
Click Create a key at the top right of the API Keys card. The Create an API key window opens.
Name the key
In Key name, type the name of the tool that will use it, for example "Looker Studio" or "Management spreadsheet". This name tells you which key to revoke later. Then click Create a key, or press Enter.
Copy the key
The full key shows, with the message Copy this key now. It will not be shown again after closing this window. Click the copy icon to the right of the key. The message Key copied to clipboard confirms it. Paste it right away into the tool or your password manager.
Close the window
Click Done. The key appears in the table.
The key is shown only once
We do not keep the key in readable form, so we cannot show it to you again. If you lost it, create a new one and revoke the old one.
Every key starts with fmx_. If creation fails, the message Failed to create key appears. Try again a little later.
Read the keys table
| Column | What it shows |
|---|---|
| Name | The name you gave the key |
| Prefix | The first characters of the key, to recognize it in a tool without showing it in full |
| Created | The creation date |
| Last used | The date of the last call made with this key, or a dash if it was never used |
While no key exists, the card shows No API keys created yet.
The Last used column helps you clean up. A key unused for months often belongs to an abandoned tool. Revoke it.
Revoke a key
Revoking a key disables it for good. Do it when a tool is no longer used, when a contractor leaves your project, or if you think someone else has seen the key.
Click Revoke
In the key's row, click Revoke.
Confirm
The Revoke API key window reminds you that integrations using this key will stop working. Click Revoke to confirm, or Cancel.
The message API key revoked confirms it. The row stays in the table with the Revoked label, as a record. Revocation is immediate and cannot be undone. To reconnect the tool, create a new key.
Keep your keys safe
A key lets someone read all your sales numbers. Treat it like a password.
- Create one key per tool, so you can cut one off without touching the others.
- Never send it in plain text by email or chat, and never paste it into a public page or code your visitors can see.
- Revoke it as soon as it is no longer needed.
We will never ask you for an API key by email or phone.
Frequently asked questions
Checkout
Add a marketing consent checkbox to your store's checkout page and record your customers' agreement for email, WhatsApp and SMS.
Account and company
Understand the difference between your account, your company and your organizations, and know where to manage your profile, your team and your subscription.