Gallery Platform API
Reference

Create a traffic sensor

Registers a physical visitor-traffic sensor (a device paired to a room or work).

POST
/gallery/traffic/sensors

Registers a physical visitor-traffic sensor (a device paired to a room or work).

Authorization

bearerAuth traffic:create
AuthorizationBearer <token>

A gallery API key, sent as Authorization: Bearer gpk_… (or the x-api-key header).

In: header

Scope: traffic:create

Header Parameters

Idempotency-Key?string

Optional. Send a unique key per logical operation to make retries safe: a retry with the same key replays the stored success for 14 days instead of re-running the write. Reusing a key with a different body returns 400.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Create a traffic sensor.

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

{  "id": "string",  "kind": "pax_radio",  "label": "string",  "location_id": "string",  "artwork_id": "string",  "device_id": "string",  "calibration": {    "property1": null,    "property2": null  },  "is_active": true,  "livemode": true,  "created_at": "string"}

Ingest traffic samples POST

Upserts a batch of anonymous aggregate visitor counts on the unique (sensor_id, bucket_start) key, so replayed at-least-once uplinks are free. Written by a device key holding `traffic:create`. No per-sample event is emitted.

Get a traffic sensor GET

Returns a single traffic sensor's configuration.