API documentation for get_traces

Back to main page
URL
/api/v1/get_traces

Get detailed traces for a given time range.

Gives full detail about the trace. There might be multiple traces for the given range, these are all returned. Values returned for each axis are as mm/s. The frequency is 1kHz. The data is sorted on start time.

Parameters:
measuring_point_id:
The ID of the measuring point from which you'd like to get the traces data
start_time:
From what time to fetch traces, time is given in milliseconds since epoch
end_time:
Till what time to fetch traces, time is given in milliseconds since epoch

Example response:

{
    "ok": true,
    "traces": {[
        {
            "start_time": 12345123,
            "end_time": 12345555,
            "x": [ 0.1, 0.11, ....],
            "y": [ 0.1, 0.11, ....],
            "z": [ 0.1, 0.11, ....],
        },
        ....
    ]}
}
Details:
start_time:
Milliseconds since epoch for the given trace
end_time:
Milliseconds since epoch for the given trace
x, y, z:
List of the velocities as mm/s.

Available API endpoints:

URL Description
/api/v1/user/authenticate Athenticate user and return a temperary API token.
/api/v1/user/account Get user account by API token.
/api/v1/token_details Tests the token and returns account info if the token is valid.
/api/v1/list_measuring_points Gives a list of measuring points that this token can access.
/api/v1/configure_measuring_point Configure a measuring point.
/api/v1/list_sensors Gives a list of sensors that this token can access.
/api/v1/get_peak_records Fetch peak particle velocity/acceleration records for a given measuring point.
/api/v1/get_vdv_records Fetch VDV records for a given measuring point.
/api/v1/get_veff_records Fetch Veff/KB records for a given measuring point.
/api/v1/get_traces_list Get a list of traces for a given time range.
/api/v1/get_traces Get detailed traces for a given time range.