Lightbug Documentation

Appearance

Get device point by id​

GET
/devices/{id}/points/{fk}

Get a specific point for device when you already know the device ID and point ID.

Authorizations​

ApiKeyAuth

API Key for authentication. Retrieval from either API version login routes, or other authentication token type. See Authentication for more details.

Type
API Key (header: Authorization)
Example"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."

Parameters​

Path Parameters

id*

device id

Type
number
Required
Format
"integer"
fk*

Foreign key for points

Type
number
Required
Format
"integer"

Request example

Responses​

Body (JSON)

application/json
JSON
{
  
"location": {
  
  
"lat": 0,
  
  
"lng": 0
  
},
  
"timestamp": "string",
  
"speed": 0,
  
"altitude": 0,
  
"course": 0,
  
"num_value": "string",
  
"stringValue": "string",
  
"sendReason": 0,
  
"sats": 0,
  
"hdop": 0,
  
"accuracy": 0,
  
"locationType": "gps",
  
"batteryVoltage": 0,
  
"batteryPct": 0,
  
"averageCharge": 0,
  
"created": "string",
  
"address": "string",
  
"alertType": 0,
  
"currentUsed": 0,
  
"gsmSignal": 0,
  
"correlationId": "string",
  
"id": 0,
  
"deviceId": 0
}
Try this endpoint

Playground​

Authorization
Variables
Key
Value

OpenAPI definition ​

References are expanded below, except recursive definitions and references with sibling fields. Documentation overrides are included. Full original OpenAPI spec (JSON).

View endpoint OpenAPI definition
yaml
openapi: 3.1.0
info:
  version: 1.1.0
  title: TrackingAPI
  description: V1 API for retrieving tracking data and changing settings on Lightbug devices
servers:
  - url: https://api.lightbug.cloud/api
externalDocs: {}
security:
  - ApiKeyAuth: []
tags: []
paths:
  /devices/{id}/points/{fk}:
    get:
      tags:
        - points
      summary: Get device point by id
      parameters:
        - name: id
          in: path
          description: device id
          required: true
          schema:
            type: number
            format: integer
        - name: fk
          in: path
          description: Foreign key for points
          required: true
          schema:
            type: number
            format: integer
      responses:
'200':
yaml
          description: Body (JSON)
          content:
            application/json:
              schema:
                properties:
                  location:
                    properties:
                      lat:
                        type: number
                      lng:
                        type: number
                    type: object
                  timestamp:
                    description: Timestamp for the datapoint. NB this is not necessarily the same as 'created'
                    type: string
                    format: date-time
                  speed:
                    description: Ground velocity in kmh, as determined by the GPS
                    type: number
                    format: ''
                  altitude:
                    description: Altitude in m, as determined by the GPS
                    type: number
                    format: ''
                  course:
                    description: Course in degrees, as determined by the GPS
                    type: number
                    format: ''
                  num_value:
                    description: Internal use only
                    type: string
                  stringValue:
                    description: Internal use only
                    type: string
                  sendReason:
                    description: "Bitfield indicating reason for datapoint transmission and status of the device at the time.\n\r\nBit1(1): Wake mode active, \n\r\nBit2(2): Sleep mode active, \n\r\nBit3(4): Bluetooth disconnected, \n\r\nBit4(8): Outside of Safe-zone, \n\r\nBit5(16): Motion detected, \n\r\nBit6(32): Device started moving, \n\r\nBit7(64): Device stopped moving, \n\r\nBit8(128): Position is stale: last known location was used\n\r\nSpecial case 255/0xFF: device was checking in with server. Ignore all data"
                    type: number
                    format: ''
                  sats:
                    description: Number of visible satellites, as determined by the GPS
                    type: number
                    format: ''
                  hdop:
                    description: Deprecated
                    type: number
                    format: ''
                  accuracy:
                    description: Accuracy of the location in meters
                    type: number
                    format: ''
                  locationType:
                    default: gps
                    description: Type of position. Can be 'gps', 'wifi', 'gsm' or 'invalid'
                    type: string
                  batteryVoltage:
                    description: Battery charge level in volts.
                    type: number
                    format: ''
                  batteryPct:
                    description: Battery charge level in %.
                    type: number
                    format: ''
                  averageCharge:
                    description: Internal Use. 255 indicates plugged in and charging.
                    type: number
                    format: ''
                  created:
                    description: Timestamp for when the datapoint was received and processed by the server
                    type: string
                    format: date-time
                  address:
                    description: A reverse geocode result for the point
                    type: string
                  alertType:
                    description: "Bitfield indicating what alerts where active at transmission time\n\r\nBit1(1): Freefall / Drop detected, \n\r\nBit2(2): Rotation detected, \n\r\nBit3(4): GSM jamming detected, \n\r\nBit4(8): Button was pressed, \n\r\nBit5(16): Generic Alert "
                    type: number
                    format: ''
                  currentUsed:
                    description: Current Used to send this location in microAmp Hours
                    type: number
                    format: ''
                  gsmSignal:
                    description: GSM CSQ value
                    type: number
                    format: ''
                  correlationId:
                    description: Internal use - correlation identifier
                    type: string
                  id:
                    type: number
                    format: ''
                  deviceId:
                    type: number
                    format: ''
                required:
                  - timestamp
                  - locationType
                  - created
                type: object
yaml
      deprecated: false
      security:
        - ApiKeyAuth: []
      operationId: get-devices-id-points-fk
      description: Get a specific point for device when you already know the device ID and point ID.
components:
  securitySchemes:
    ApiKeyAuth:
      in: header
      name: Authorization
      type: apiKey
      description: API Key for authentication. Retrieval from either API version login routes, or other authentication token type. See <a href='/apis/authentication'>Authentication</a> for more details.
      example: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...