SDK & API keys
SDK & API keys in the Settings area (Workspace) — route /account-management.
SDK & API keys lives in the Settings area of the dashboard, under Workspace.
At a glance#
| Dashboard route | /account-management |
| Area | Settings (settings) |
| Group | Workspace |
| Platforms | Available for every app platform. |
| Note | This entry points outside its area's usual /{area}/{slug} pattern. |
What it does#
SDK keys are the credentials your app uses to report data. This page issues them, lists them with their last four characters, and revokes them. Each key belongs to an app and an environment, which is what determines where the data it carries lands.
When to use it#
Once per app and environment during setup, and then whenever a key needs rotating.
Workflow#
Create a key per environment
One key per app per environment. Sharing a key between production and staging removes the boundary you created the environments for.
Copy it at creation
The full key is shown once. Afterwards only the last four characters are visible — by design, because a credential you can read back out of a dashboard is a credential anyone with dashboard access can read.
Put it in your build configuration, not your source
Even a client key does not belong in a committed file. Use whatever your platform provides for build-time configuration.
Verify it works
Check Devices — it populates before any analytics do, so it is the fastest confirmation that a key is correct.
Permissions and prerequisites#
Requires a developer or administrative role. Every key creation, revocation and rotation is recorded in the audit log.
Limits and edge cases#
Revocation is immediate and breaks live builds. Any released app still using a revoked key stops reporting, and you cannot un-revoke. Roll a new key out before revoking the old one.
Only the last four characters are visible after creation. Store it wherever you keep build secrets.
A key is bound to one app and environment. Using the wrong key reports successfully into somewhere you are not looking, which is the most confusing possible failure.
Troubleshooting#
No data after integrating. Confirm the key belongs to the app and the environment you are watching. This is the most common integration problem.
Data stopped after a rotation. A build is still using the revoked key. Released apps do not update their key when you rotate.
Where the data comes from#
A client key can only write telemetry — it cannot read data or change configuration, which is what makes shipping it inside your app acceptable.
From the SDK
Served by
SDK keys
Environments