Get heatmap data
GET /v1/projects/{id}/heatmap
Returns aggregated heatmap cells for a specific map. Each cell contains performance metrics (FPS, frame time, memory, GPU time) and event counts. Use in Performance mode (no eventName) for QA or Events mode (with eventName) for game design analysis.
Authorizations
Section titled “Authorizations ”Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ”Project UUID.
Query Parameters
Section titled “Query Parameters ”User-specified map identifier to query heatmap data for.
Grid cell size in world units.
Time period in days.
Filter by event name (e.g., player.death). Omit for performance mode.
Responses
Section titled “ Responses ”Array of heatmap cells.
object
Aggregated performance and event data for a single grid cell.
object
Cell center X coordinate in world space.
Cell center Y coordinate in world space.
Normalized weight for visualization.
Number of events in this cell.
Average FPS across all samples in this cell.
Average frame time (ms) across all samples.
Average memory usage (MB) across all samples.
Average GPU time (ms), or null if no GPU data available.
Headers
Section titled “Headers ”Maximum number of requests allowed per hour.
Number of requests remaining in the current window.
Unix timestamp when the rate limit window resets.
Invalid request parameters or body.
object
Human-readable error message.
Missing or invalid API key.
object
Human-readable error message.
Resource not found.
object
Human-readable error message.
Rate limit exceeded.
object
Human-readable error message.
Headers
Section titled “Headers ”Maximum number of requests allowed per hour.
Number of requests remaining in the current window.
Unix timestamp when the rate limit window resets.