This API call queries recorded data from the database recorder.
Supported HTTP methods: POST, OPTIONS
POST /api/v1/recordingdata
Parameters: none
Expected Payload: A RecorderQuery document specifying which data to query from the database
Replied Payload: A RecorderDataPoint list containing the data replied by the database.
Return Codes:
| Code | Description |
|---|---|
| 200 | OK, returns a JSON document. |
| 401 | not logged in. In this case an ApiError document is returned,describing details of the error. |
| 400 | Bad Request. In case validation failed on payload |
POST /api/v1/recordingdata/raw
This API call queries recorded data from the database recorder and retruns raw data.
Parameters: none
Expected Payload: A RecorderQuery document specifying which data to query from the database
Replied Payload: A RecorderRawDataPoint list containing the data replied by the database.
Return Codes:
| Code | Description |
|---|---|
| 200 | OK, returns a JSON document. |
| 401 | not logged in. In this case an ApiError document is returned,describing details of the error. |
| 400 | Bad Request. In case validation failed on payload |
POST /api/v1/recordingdata/csv
This API call queries recorded data from the database recorder and retruns String (text/csv).
Parameters: none
Expected Payload: A RecorderQuery document specifying which data to query from the database
Replied Payload: A CSV string (text/csv)
Return Codes:
| Code | Description |
|---|---|
| 200 | OK, String |
| 401 | not logged in. In this case an ApiError document is returned,describing details of the error. |
| 400 | Bad Request. In case validation failed on payload |
POST /api/v1/recordingdata/state_duration
This API executes a state‑duration query for a recorder.
Depending on the numberValue flag in RecorderDurationState, it returns either numeric or string state durations.
Parameters: none
Expected Payload: A RecorderDurationState document containing query parameters.
Replied Payload: An array or single of state‑duration result(s). If numberValue RecorderNumStateDuration else RecorderStringStateDuration.
Return Codes:
| Code | Description |
|---|---|
| 200 | OK, returns the query result. |
| 401 | Not logged in. An ApiError document is returned. |
| 400 | Bad Request. Validation failed on payload. |
/api/v1/recordingdata/chunk_job
This API creates a retention policy that deletes all chunks older than the specified date range.
Supported HTTP methods: POST, DELETE
POST /api/v1/recordingdata/chunk_job
Create or modify the retention policy.
Parameters: none
Expected Payload: A string describing the duration (e.g., "6 months").
Replied Payload: The ID of the created retention policy.
Return Codes:
| Code | Description |
|---|---|
| 201 | Created, returns the policy ID. |
| 401 | Not logged in or insufficient privileges. An ApiError document is returned. |
| 403 | Forbidden. An privilege level 150 is required |
| 400 | Bad Request. Validation failed on payload. |
DELETE /api/v1/recordingdata/chunk_job
Removes the auto job that deletes older chunks.
Parameters: none
Replied Payload: Boolean indicating success (true).
Return Codes:
| Code | Description |
|---|---|
| 204 | No Content, deletion succeeded. |
| 401 | Not logged in or insufficient privileges. An ApiError document is returned. |
| 403 | Forbidden. An privilege level 150 is required |
/api/v1/recordingdata/drop_chunks
This API drops all chunks older than the specified date.
Supported HTTP methods: DELETE
DELETE /api/v1/recordingdata/drop_chunks
Parameters: none
Expected Payload: A string with an ISO‑8601 date (e.g., "2023-01-01").
Replied Payload: Boolean indicating success (true).
Return Codes:
| Code | Description |
|---|---|
| 204 | No Content, deletion succeeded. |
| 401 | Not logged in or insufficient privileges. An ApiError document is returned. |
| 403 | Forbidden. An privilege level 150 is required |
| 400 | Bad Request. Invalid date format |
/api/v1/recordingdata/db_info
Retrieves information about the recorder database.
Supported HTTP methods: GET
GET /api/v1/recordingdata/db_info
Parameters: none
Replied Payload: A RecorderDbInfo object with database metrics.
Return Codes:
| Code | Description |
|---|---|
| 200 | OK, returns database information. |
| 401 | Not logged in. An ApiError document is returned. |
/api/v1/recordingdata/chunks_info
Retrieves detailed information about all recorder chunks.
Supported HTTP methods: GET
GET /api/v1/recordingdata/chunks_info
Parameters: none
Replied Payload: An array of RecorderChunkInfo objects.
Return Codes:
| Code | Description |
|---|---|
| 200 | OK, returns chunk information. |
| 401 | Not logged in. An ApiError document is returned. |