GamebeastDocs
Dashboard
SDK V1Heatmaps

Create a heatmap

POST
/sdk/v1/heatmaps/create

Creates a new heatmap for this application. Bounds are defined as two opposing world-space points (pointA, pointB); resolutionFactor (1-255) sets sample density. Optional description and metadata are stored alongside the definition.

Authorization

sdkApiKey
authorization<token>

SDK (public) key, prefixed gb_pk_ (older keys: sdk_). Send it as the authorization header value. Scoped to one project, so it is safe to ship in a game build.

In: header

Header Parameters

isstudio?|
Defaulttrue
project-id?integer
Range0 < value <= 9007199254740991

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

curl -X POST "https://example.com/sdk/v1/heatmaps/create" \  -H "Content-Type: application/json" \  -d '{    "name": "string",    "bounds": {      "pointA": {        "x": 0,        "y": 0,        "z": 0      },      "pointB": {        "x": 0,        "y": 0,        "z": 0      }    },    "resolutionFactor": 1  }'
{}