Quick Start

This guide walks you through creating a free Framedash account, integrating the SDK, and sending your first performance data.

Using an AI coding agent?

If you use an AI coding agent (Claude Code, Codex, or any MCP client), it can wire up Framedash for you. See the Claude Code Plugin, Codex CLI, or the AGENTS.md snippet to hand the agent the docs, CLI, and MCP server.

1. Create an Account

1. Open the Framedash sign-up page
2. Register with your email address, or continue with Google, GitHub, or Microsoft
3. Accept the terms to finish creating your account

2. Create a Project and API Key

After logging in to the dashboard:

1. Click “New Project”
2. Enter a project name and create the project
3. Open the project and go to “API Keys”
4. Choose the Ingest preset and copy the new fd_ API key before closing the dialog

Note

On the Free plan you can keep up to 2 active API keys per project, and a key value is shown only once when you create it. If you reach the cap, deactivate an old key before creating a new one.

An Ingest key can only send events. To verify ingestion later via the CLI or REST raw SQL queries, you will need a separate Full key (raw SQL requires the data:admin scope; covered in step 5).

3. Integrate the SDK

Integrate the SDK for your engine:

• Unity SDK Setup →
• UE5 SDK Setup →
• Godot SDK Setup →

4. Send Data

Once the SDK is set up, performance data is automatically sent to Framedash when you run your game.

Running from CI or a headless build? See your engine’s Headless / CI section: Unity, UE5, or Godot.

Tip

During your first integration, enable the SDK’s verbose logging so you can see delivery confirmations. A successful batch logs an HTTP 202. Ingested events take about 20-30 seconds to appear in builds and the dashboard, so a short delay does not mean ingestion failed. If nothing arrives, see Troubleshooting.

5. View the Heatmap

Open the project’s “Maps” page, upload a map or generate demo data, then open the map and switch to Heatmap mode to see performance data overlaid on it.

To confirm ingestion without the dashboard, query your data from the CLI or the REST query endpoint. Raw SQL queries require the data:admin scope, so use a Full API key — a Read-only key gets a 403.

Next Steps

• Data Model: Understand the structure of the data being sent
• Events Schema: Columns you can query
• Troubleshooting: When events do not show up
• CI Profiling: Set up automated testing