Projects and API keys

What a project is, where to find its ID and API key, and how to replace a key.

Projects

A project is one site or app. Its logs, issues, sessions, linked GitHub repository, team and settings all belong to it. If you run a website and a separate API, you can send both to one project and tell them apart with serviceName, or give each its own project.

Project ID

Every project has an ID, a 24-character string. The SDK needs it, and so does every API call. Find it in the dashboard address after /projects/, or in the code preview on Settings › SDK Config.

API key

Each project has one API key. The SDK sends it in the X-API-Key header with every request, and your CI uses it to record deploys. Find it in Settings › API Key.

Treat the key as public

When the SDK runs in a browser, the key is part of your site’s JavaScript, so anyone who opens the page can read it and send data to your project with it. Don’t paste it anywhere you wouldn’t paste your site’s source. If someone sends junk with it, replace it.

Replacing a key

Settings › API Key › Regenerate API Key issues a new key. The old one stops working at once, so:

update your app and deploy it, or logs from visitors on the old build are rejected;
update the key in any CI job that records deploys or uploads source maps.

Keys don’t expire on their own.

Team members

Add people in Settings › Team as an admin or a viewer. Everyone on the team can see the project. Changing things, such as resolving or ignoring an issue, creating a GitHub issue, or re-syncing commits, needs the owner or an admin.

New-error notifications go to the project owner only. See Notifications and alerts for ways to reach the rest of the team.

How long data is kept

Logs are kept for 30 days by default. Change it in Settings › Retention.
Session replays are deleted 7 days after they are recorded.