API documentation for get_peak_records

Back to main page
URL
/api/v1/get_peak_records

Fetch peak particle velocity/acceleration records for a given measuring point.

Parameters:
measuring_point_id:
From what measuring point to fetch samples. This is the "id" field when fetching details about measuring points
start_time:
From what time to fetch samples, time is given in milliseconds since epoch
end_time:
Till what time to fetch samples, time is given in milliseconds since epoch (optional)

Example response:

{
    "ok": true,
    "samples": [
        {
            "timestamp": 12312312312,
            "category": "CAT1",
            "measuring_type": "indicative",
            "vibration_type": "continuous",
            "guide_line": "DIN4150-3",
            "x": {
                "Fdom": 12.2,
                "Vtop": 1.2,
            }
            "y": {
                "Fdom": 3.2,
                "Vtop": 0.8,
            }
            "z": {
                "Fdom": 1.1,
                "Vtop": 20.2.
            }
        },
        ....
    ]
}
Details:
timestamp:
Milliseconds since epoch for the given sample
category:
Which category was used to preform SBR-A calculations with.
measuring_type:
What kind of measurement was done
vibration_type:
What kind of vibrations were measured.
guide_line:
The guideline used by the Swarm.
Fdom:
The dominant frequency which belongs to the Vtop
Vtop:
The top velocity of the sample.

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.