Config

Production reader

https://api.exati.com.br/tracking/read

POST

/config

This method is responsible for creating a configuration for delimiting the parameters used for generating reports.

Request

Body Params application/json

maxSpeedKmh

integer

required

Speed limit to consider a position as above the speed limit on the Speeding report.

>= 0

minStopMinutes

integer

required

Minimum time required to consider a segment as STOPPED on the movements report.

>= 0

maxStopSpeedKmh

integer

required

Minimum speed required to consider a segment as STOPPED on the movements report.

>= 0

maxStopDistanceMeters

integer

required

Minimum distance traveled to consider a segment as STOPPED on the movements report.

>= 0

minMovementSpeedKmh

integer

required

Minimum speed required to consider a segment as MOVING on the movements report.

>= 0

minMovementDistanceMeters

integer

required

Minimum distance required to consider a segment as MOVING on the movements report.

>= 0

gapThresholdSeconds

integer

required

Minimum time between data submissions to consider a segment as a GAP on the movements report.

>= 0

Example

{
    "maxSpeedKmh": 70,
    "minStopMinutes": 3,
    "maxStopSpeedKmh": 1,
    "maxStopDistanceMeters": 50,
    "minMovementSpeedKmh": 2,
    "minMovementDistanceMeters": 100,
    "gapThresholdSeconds": 300
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.exati.com.br/tracking/read/config' \
--header 'Content-Type: application/json' \
--data-raw '{
    "maxSpeedKmh": 70,
    "minStopMinutes": 3,
    "maxStopSpeedKmh": 1,
    "maxStopDistanceMeters": 50,
    "minMovementSpeedKmh": 2,
    "minMovementDistanceMeters": 100,
    "gapThresholdSeconds": 300
}'

Responses

🟢200OK

application/json

Example of a Successful response

Body

status

string

optional

message

string

optional

Entity processed successfully

Example

{
    "status": "ok",
    "message": "Entity processed successfully"
}

🟠400Bad Request

🟠409409

Modified at 2025-02-25 19:51:15

latest-positions :deviceId

Config