Send label data from a Gateway device

POST /external/v1/label-data

Api key

Headers

x-api-key string Required

Contact team@reelables.com to get an api key.
request-id string

Unique identifier for the API request. Example: f7ecf495-ca1c-4468-a6c2-6ee3f723fa00

application/json

Body Required

Gateway label data payload

providerDeviceId string Required

Identifier of the Gateway device. Example: 'd290f1ee-6c54-4b01-90e6-d701748f0851'

Maximum length is 50. Format should match the following pattern: ^[-_A-Za-z0-9]*$.
data object Required
Hide data attribute Show data attribute object
- labels array[object] Required
  
  Labels data being sent from the Gateway device
  
  Not more than 1000 elements.
  One of:
  object-1 object object-2 object
  
  Hide attributes Show attributes
  
  bleId integer(int32) Required
  
  Label BLE identifier. Example: 123
  
  Minimum value is 0, maximum value is 2147483647.
  
  macAddress string
  
  The label mac address: e.g. 80:EA:00:00:00:7B
  
  data array[object] Required
  
  Data for the label being sent from the Gateway device
  
  Not more than 1000 elements.
  
  Hide data attributes Show data attributes object
  
  rssi integer(int32)
  
  RSSI value in dB of the label
  
  Minimum value is -127, maximum value is 0.
  
  beaconPayload string
  
  The 'manufacturer specific data' BLE payload reported by the Label. Example: 'db0a03140000df91645d130004000000aabbcc016a0a717c00000001'
  
  temperature number(float)
  
  Temperature value reported by the label, in degrees centigrade. Example: -2.1
  
  Minimum value is -100, maximum value is 500.
  
  battery integer(int32)
  
  The Label battery level, in mV. Example: 2832
  
  Minimum value is 0, maximum value is 2147483647.
  
  timestamp string(date-time) Required
  
  Timestamp of the label data in UTC ISO format. Example: '2019-07-21T17:32:28Z'
  
  rawTemperature integer(int32)
  
  The ADC reading reported by the Label temperature sensor. Example 43558
  
  Minimum value is 0, maximum value is 2147483647.
  
  Hide attributes Show attributes
  
  bleId integer(int32)
  
  Label BLE identifier. Example: 123
  
  Minimum value is 0, maximum value is 2147483647.
  
  macAddress string Required
  
  The label mac address: e.g. 80:EA:00:00:00:7B
  
  data array[object] Required
  
  Data for the label being sent from the Gateway device
  
  Not more than 1000 elements.
  
  Hide data attributes Show data attributes object
  
  rssi integer(int32)
  
  RSSI value in dB of the label
  
  Minimum value is -127, maximum value is 0.
  
  beaconPayload string
  
  The 'manufacturer specific data' BLE payload reported by the Label. Example: 'db0a03140000df91645d130004000000aabbcc016a0a717c00000001'
  
  temperature number(float)
  
  Temperature value reported by the label, in degrees centigrade. Example: -2.1
  
  Minimum value is -100, maximum value is 500.
  
  battery integer(int32)
  
  The Label battery level, in mV. Example: 2832
  
  Minimum value is 0, maximum value is 2147483647.
  
  timestamp string(date-time) Required
  
  Timestamp of the label data in UTC ISO format. Example: '2019-07-21T17:32:28Z'
  
  rawTemperature integer(int32)
  
  The ADC reading reported by the Label temperature sensor. Example 43558
  
  Minimum value is 0, maximum value is 2147483647.
signalStrength number(float)

Cellular signal strength indicator, in decibels. Example: -30dBm
temperature number(float)

Temperature reported by the Gateway device, in degrees centigrade. Example: -2.1

Minimum value is -200, maximum value is 500.
location object

Location of the Gateway when data is sent
Hide location attributes Show location attributes object
- latitude number(float) Required
  
  Latitude value of the coordinate. Example: 51.123
  
  Minimum value is -90, maximum value is 90.
- accuracy number(float) Required
  
  The horizontal accuracy of the coordinate, in metres. Example: 18.20
  
  Minimum value is 0, maximum value is 1000000.
- longitude number(float) Required
  
  Longitude value of the coordinate. Example: -0.123
  
  Minimum value is -180, maximum value is 180.
timestamp string(date-time) Required

Timestamp at which the Gateway is sending the data, in UTC ISO format. Example: '2024-07-21T17:32:28Z'
batteryLevel number(float)

Device battery charge level, as a percentage. Example: 42%

Responses

202

Events received and queued for processing
400

Invalid input, object invalid

POST /external/v1/label-data

curl \
 --request POST 'https://api.reelables.com/gateway/external/v1/label-data' \
 --header "Content-Type: application/json" \
 --header "x-api-key: string" \
 --header "request-id: string" \
 --data '{"providerDeviceId":"d290f1ee-6c54-4b01-90e6-d701748f0851","data":{"labels":[{"bleId":34512,"macAddress":"80:EA:00:00:00:7B","data":[{"rssi":-70,"beaconPayload":"db0a03140000df91645d130004000000aabbcc016a0a717c00000001","temperature":-2.1,"battery":2832,"timestamp":"2019-07-21T17:32:28Z","rawTemperature":43558}]}]},"signalStrength":-30,"temperature":-2.1,"location":{"latitude":51.5074,"accuracy":18.5,"longitude":-0.1278},"timestamp":"2019-07-21T17:32:28Z","batteryLevel":42}'

Request examples

# Headers
x-api-key: string
request-id: string

# Payload
{
  "providerDeviceId": "d290f1ee-6c54-4b01-90e6-d701748f0851",
  "data": {
    "labels": [
      {
        "bleId": 34512,
        "macAddress": "80:EA:00:00:00:7B",
        "data": [
          {
            "rssi": -70,
            "beaconPayload": "db0a03140000df91645d130004000000aabbcc016a0a717c00000001",
            "temperature": -2.1,
            "battery": 2832,
            "timestamp": "2019-07-21T17:32:28Z",
            "rawTemperature": 43558
          }
        ]
      }
    ]
  },
  "signalStrength": -30,
  "temperature": -2.1,
  "location": {
    "latitude": 51.5074,
    "accuracy": 18.5,
    "longitude": -0.1278
  },
  "timestamp": "2019-07-21T17:32:28Z",
  "batteryLevel": 42
}