Overview
Framedash API (1.0)
Section titled “Framedash API (1.0)”The Framedash API provides programmatic access to game performance telemetry, project management, map management, content registry, and analytics queries.
Authentication
All requests require an API key sent via the X-API-Key header.
API keys can be generated from the Framedash dashboard under
Settings > API Keys.
Response Format
Web API
All Web API responses use the envelope:
{ "success": true, "data": { ... } }Error responses:
{ "success": false, "error": "Error message" }Ingest API
The Event Ingestion endpoint (/v1/events) uses a different format:
{ "status": "accepted" }- OpenAPI version: 3.1.0
Authentication
Section titled “ Authentication ”ApiKeyAuth
Section titled “ApiKeyAuth ”API key for authentication. Generate keys from the Framedash dashboard under Settings > API Keys.
Key types:
- admin — Full access to Web API endpoints
- write — Event ingestion only
- ci — Event ingestion (CI builds, bypasses billing)
Security scheme type: apiKey
Header parameter name: X-API-Key