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.
Set to true to bin cells vertically as well, producing 3D voxels.
Each returned cell then includes a z coordinate, and the same
x/y position may appear multiple times, once per Z layer.
Values other than true or false are rejected with 400.
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.
Cell center Z coordinate in world space. Present only when the
request sets includeZ=true; omitted otherwise.
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.
Average VRAM usage (MB), or null if no VRAM 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.
RFC 9457 Problem Details. Served with the application/problem+json
media type. error_category, retryable, and retry_after are
Framedash extension members. type always defaults to about:blank,
so it is always present; detail and the extension members are present
only when applicable.
object
Problem type URI; about:blank when no specific type applies.
Short, human-readable summary of the problem type.
HTTP status code.
Human-readable explanation specific to this occurrence.
Extension member categorizing the error.
Extension member; true when retrying may succeed (e.g. 429, 503).
Extension member; suggested retry delay in seconds, when applicable.
Missing or invalid API key.
RFC 9457 Problem Details. Served with the application/problem+json
media type. error_category, retryable, and retry_after are
Framedash extension members. type always defaults to about:blank,
so it is always present; detail and the extension members are present
only when applicable.
object
Problem type URI; about:blank when no specific type applies.
Short, human-readable summary of the problem type.
HTTP status code.
Human-readable explanation specific to this occurrence.
Extension member categorizing the error.
Extension member; true when retrying may succeed (e.g. 429, 503).
Extension member; suggested retry delay in seconds, when applicable.
Resource not found.
RFC 9457 Problem Details. Served with the application/problem+json
media type. error_category, retryable, and retry_after are
Framedash extension members. type always defaults to about:blank,
so it is always present; detail and the extension members are present
only when applicable.
object
Problem type URI; about:blank when no specific type applies.
Short, human-readable summary of the problem type.
HTTP status code.
Human-readable explanation specific to this occurrence.
Extension member categorizing the error.
Extension member; true when retrying may succeed (e.g. 429, 503).
Extension member; suggested retry delay in seconds, when applicable.
Rate limit exceeded.
RFC 9457 Problem Details. Served with the application/problem+json
media type. error_category, retryable, and retry_after are
Framedash extension members. type always defaults to about:blank,
so it is always present; detail and the extension members are present
only when applicable.
object
Problem type URI; about:blank when no specific type applies.
Short, human-readable summary of the problem type.
HTTP status code.
Human-readable explanation specific to this occurrence.
Extension member categorizing the error.
Extension member; true when retrying may succeed (e.g. 429, 503).
Extension member; suggested retry delay in seconds, when applicable.
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.
Number of seconds to wait before retrying. Present only on 429
responses. Because the limit uses a sliding window, honor this value
per response rather than scheduling a retry for the reset time.