API Overview

Use the Framedash REST API to retrieve and analyze telemetry data.

Note

Detailed API reference pages are available in the “Framedash API” section of the sidebar.

Base URL

Service	URL
Web API (Projects, Maps, Content, Query, Analytics, Alerts)	https://api.framedash.dev/api
Ingest API (Event Ingestion)	https://ingest.framedash.dev

Authentication

All requests require an API key. Send it via the X-API-Key header:

X-API-Key: fd_your_api_key_here

You can obtain your API key from “Settings” > “API Keys” in the dashboard.

API Key Types

Type	Usage
admin	Full access to Web API endpoints
write	Event ingestion only
ci	Event ingestion for CI builds (bypasses billing)

Rate Limits

Rate limits are applied based on your plan. You can check limits via response headers:

X-RateLimit-Limit: 2000
X-RateLimit-Remaining: 1999
X-RateLimit-Reset: 1700000000

Response Format

Web API

On success:

{
  "success": true,
  "data": { ... }
}

On error:

{
  "success": false,
  "error": "Error message"
}

Ingest API

On success:

{
  "status": "accepted"
}

On error:

{
  "error": "Error message"
}

OpenAPI Spec

The API specification is available for download in OpenAPI 3.1 format.

Endpoints

See the auto-generated API reference in the sidebar for full details.

Projects

Endpoint	Method	Description
/v1/projects	GET	List projects
/v1/projects/{id}/status	GET	Get project status

Analytics

Endpoint	Method	Description
/v1/projects/{id}/dashboard	GET	Get dashboard metrics (DAU, MAU, sessions, events)
/v1/projects/{id}/heatmap	GET	Get heatmap data for a map
/v1/projects/{id}/retention	GET	Get player retention cohorts
/v1/projects/{id}/funnels	GET	Get funnel conversion analysis
/v1/projects/{id}/insights	GET	Get aggregated analytics by dimension

Alerts

Endpoint	Method	Description
/v1/projects/{id}/alerts	GET	List alert rules
/v1/projects/{id}/alerts	POST	Create an alert rule
/v1/projects/{id}/alerts/{alertId}	GET	Get an alert rule
/v1/projects/{id}/alerts/{alertId}	PATCH	Update an alert rule
/v1/projects/{id}/alerts/{alertId}	DELETE	Deactivate an alert rule
/v1/projects/{id}/alerts/history	GET	List alert evaluation history

Maps

Endpoint	Method	Description
/v1/projects/{id}/maps	GET	List maps
/v1/projects/{id}/maps/{mapId}	DELETE	Delete a map
/v1/maps/upload	POST	Upload a map

Content Registry

Endpoint	Method	Description
/v1/content	GET	List content entries
/v1/content	POST	Create or update content entries
/v1/content	DELETE	Delete a content entry

Query

Endpoint	Method	Description
/v1/query	POST	Execute an analytics query

Event Ingestion

Endpoint	Method	Description
/v1/events	POST	Ingest telemetry events