Skip to content
Butlr Data Center API

Read raw thermal frames

GET
/v1/sensors/{key}/frames
curl --request GET \
  --url 'https://api.datacenter.butlr.io/v1/sensors/example/frames?from=1&to=1&limit=2000&compensate=0&include_raw=1' \
  --header 'Authorization: Bearer <token>'

Return archive-backed raw thermal matrices for one currently owned sensor.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
key
required
string

Wireless MAC or wired serial discovered through GraphQL.

Query Parameters

Section titled “Query Parameters”
from
required
integer format: int64

Inclusive start time in Unix milliseconds.

to
required
integer format: int64

End time in Unix milliseconds.

limit
integer
default: 2000 <= 5000

Maximum sampled frames. Default 2000; values above 5000 are clamped. Zero requests all frames within server bounds.

hallId
string

Optional hall context for hall-specific temperature compensation.

compensate
string
Allowed values: 0 false

Set to 0 or false to return the raw device field without angle compensation.

include_raw
string
Allowed values: 1 true

With compensation active, set to 1 or true to include the original matrix as raw_data.

Responses

Section titled “Responses”

200

Section titled “200”

Thermal frames in chronological order

Media typeapplication/json
object
key
required
string
kind
required
string
Allowed values: wireless wired
tier
required
string
Allowed values: fine coarse
from
required
integer format: int64
to
required
integer format: int64
count
required
integer
total
required
integer
sampled
required
boolean
objects
required
integer
missing
required
integer
compensated
boolean
pivot_fallback_frames
integer
frames
required
Array<object>
object
timestamp
required

Device timestamp in Unix milliseconds.

integer format: int64
min_c
required
number format: double
max_c
required
number format: double
data
required

Row-major uint16 deciKelvin thermal matrix.

Array<Array<integer>>
raw_data

Uncompensated matrix when include_raw is enabled and compensation is applied.

Array<Array<integer>>
pivot_fallback
boolean

Example 

{
  "kind": "wireless",
  "tier": "fine"
}

400

Section titled “400”

Invalid request

Media typeapplication/json
object
message
string
key
additional properties
any

Example generated

{
  "message": "example"
}

401

Section titled “401”

Missing, invalid, expired, or revoked token

Media typeapplication/json
object
message
string
key
additional properties
any

Example generated

{
  "message": "example"
}

403

Section titled “403”

Route, operation, or resource is outside the token’s read-only organization scope

Media typeapplication/json
object
message
string
key
additional properties
any

Example generated

{
  "message": "example"
}

429

Section titled “429”

Request rate exceeded; honor Retry-After

Media typeapplication/json
object
message
string
key
additional properties
any

Example generated

{
  "message": "example"
}

502

Section titled “502”

Archive read failed

Media typeapplication/json
object
message
string
key
additional properties
any

Example generated

{
  "message": "example"
}

503

Section titled “503”

Required backend or token store unavailable

Media typeapplication/json
object
message
string
key
additional properties
any

Example generated

{
  "message": "example"
}