API docs by Redocly

BXT API Documentation (1.0)

Download OpenAPI specification:

API documentation for BXT products including events, KPI, and configuration endpoints

Events

Get all events

Get all events

Authorizations:
bearerAuth
Request Body schema: application/json
required
sn
required
Array of arrays

list of the sn of the worksite

begin
required
string

Begin date

end
required
string

End date

geolocate
string

The global filter

camera
string
Enum: "all" "rear" "front"

camera position. Options are all / rear / front

type
string[]

DEPRECATED and Disabled _ type of event, P for pedestrian and V for vehicule

snap
string

All events by default, yes to get only with images

snap_mode
string
Enum: "original" "blur" "hidden"

Pick the snap you want to receive - hidden will not return any images

filter_duration
string

filter_duration

number_duration
string

A number

filter_distance
string

filter_distance

number_distance
string

A number

scrollId
string

for pagination, it is an _id returned by the first response from the api

Responses

Request samples

Content type
application/json
{
  • "sn": [
    ],
  • "begin": "2023-08-09T11:27:33+01:00",
  • "end": "2023-08-11T11:27:33+01:00",
  • "geolocate": "all or yes or no",
  • "camera": "all",
  • "type": [
    ],
  • "snap": "all or yes or no",
  • "snap_mode": "original",
  • "filter_duration": "gt or lt",
  • "number_duration": "10",
  • "filter_distance": "gt or lt",
  • "number_distance": "10",
  • "scrollId": "string"
}

Get all shock detector events

Get all shock events

Authorizations:
bearerAuth
Request Body schema: application/json
required
sn
required
Array of arrays

list of the sn of the worksite

begin
required
string

Begin date

end
required
string

End date

snap
string

All events by default, yes to get only with images

minHor
number

All events by default, horizontal minimum value

maxHor
number

All events by default, horizontal maximum value

minVer
number

All events by default, vertical minimum value

maxVer
number

All events by default, vertical maximum value

Responses

Request samples

Content type
application/json
{
  • "sn": [
    ],
  • "begin": "2023-08-09T11:27:33+01:00",
  • "end": "2023-08-11T11:27:33+01:00",
  • "snap": "all or yes or no",
  • "minHor": 0,
  • "maxHor": 0,
  • "minVer": 0,
  • "maxVer": 0
}

Get operating hours for a list of kits within a specified date range

Retrieve operating hours for a list of kits within the specified date range.
The request body should include the following parameters:
- sn (array, required): An array of serial numbers for the kits.
- begin (string, required): The start date of the date range (format: YYYY-MM-DDTHH:mm:ssZ).
- end (string, required): The end date of the date range (format: YYYY-MM-DDTHH:mm:ssZ).

Authorizations:
bearerAuth
Request Body schema: application/json
required
sn
required
Array of strings

list of the sn of the worksite

begin
required
string <date-time>

Begin date

end
required
string <date-time>

End date

Responses

Request samples

Content type
application/json
{
  • "sn": [
    ],
  • "begin": "2023-06-01T00:00:00+08:00",
  • "end": "2023-06-21T15:50:00+08:00"
}

Config

Get all BXTO products configuration

Get all BXTO products configuration

Authorizations:
bearerAuth
Request Body schema: application/json
required
sn
required
Array of arrays

list of the sn of the worksite

Responses

Request samples

Content type
application/json
{
  • "sn": [
    ]
}

Get all BXT5 products configuration

Get all BXT5 products configuration

Authorizations:
bearerAuth
Request Body schema: application/json
required
sn
required
Array of arrays

list of the sn of the worksite

Responses

Request samples

Content type
application/json
{
  • "sn": [
    ]
}