API Reference
The Gamebeast HTTP API — the SDK surface your game calls, and the server and management API.
Every page in this section is generated from the Gamebeast API's own route definitions, so it
always matches what the API accepts. Requests go to https://api.gamebeast.gg.
Authentication
| Credential | Header | Used by |
|---|---|---|
SDK key (gb_pk_…) | authorization: <key> | The SDK endpoints your game client calls. Safe to ship in a game build. |
Server key (gb_sk_…) | Authorization: Bearer <key> | Server-to-server calls. Never ship it in a game build. |
Personal access token (gb_pat_…) | Authorization: Bearer <token> | Scripts acting as you. Can never exceed your own permissions. |
Create keys in the dashboard — see API Keys. Each endpoint lists which credentials it accepts.
SDK V2
Bootstrap
Whole-environment snapshot for SDK startup and polling: every configuration with its content hash, plus the active experiments split by unit type. Experiments come without changesets (SDK API key).
Configurations
Fetch and evaluate remote configurations. Without identity headers, returns the base configuration with hash-based 304. With identity headers, evaluates active experiments, merges changesets, and returns per-unit content with experiment metadata (SDK API key).
Experiments
Runtime experiment resolution for SDKs: assignment lookup (single and bulk) and the active-experiment catalog with changesets for local merging (SDK API key).
SDK V1
Configurations
Fetch active remote configurations for a game client. Legacy envelope format (SDK API key).
Experiments
Experiment snapshots and variant assignment for in-game players (SDK API key)
Cohorts
Resolve cohort membership for players from the SDK (SDK API key)
Heatmaps
Submit heatmap event data from the SDK (SDK API key)
Requests
Job request queue for in-game SDK runtimes (SDK API key)
Versioning
SDK loader version discovery (public)
Ingestion
Event and marker ingestion (SDK API key)
Webhook Triggers
Public webhook receivers that forward third-party payloads into ingestion
Server API
Analytics Queries
Execute analytics queries (insight, funnel, heatmap, retention) via the v1 type-specific endpoints. Accepts API key or session auth.
Query Builder
Event/property metadata endpoints for the query builder UI (API key or session)
Markers
Marker definitions and lookup for analytics (session, server key, or PAT)
Cohorts
Cohort management and resolution (session or PAT)
GDPR
Data subject export and erasure requests
Project API
Configurations
Remote configuration authoring and management (session or PAT)
Experiments (V2)
Experiment authoring, termination, and assignment management. Groups carry changesets against a base configuration (session or PAT)
Experiments (V1)
Legacy experiment authoring, termination, and manual membership. Groups carry frozen configuration snapshots (session or PAT)
Deeplinks
Deeplink generation and management
Environments
Discover a project's environments by canonical name. Names are the identifier every new API surface takes (the environment header); numeric ids are legacy