Augeias post process API

License: MIT

Version: 1.0.0

Description: Augeias post process API

Tags: augeias, post process, api

Installation

git clone https://github.com/firvain/augeias-post-api.git
cd augeias-post-process-api
yard install

Usage

Sensors Endpoints

Get data from a sensor from date

curl -X GET "http://localhost:3000/v1/{sensor}?from=YYYY-MM-DD" -H "accept: application/json"

Get all data from a sensor

curl -X GET http://localhost:3000/v1/{sensor}/all

Available sensors:

atmos
aquatroll
triscan
proteus
scanchlori
teros
addvantage

Example

curl -X GET "http://localhost:3000/v1/addvantage?from=2022-09-28" -H "accept: application/json"

Metrics Endpoints

Get metrics from a sensor from date

curl -X GET "http://localhost:3000/v1/metrics/{dataset}?from=YYYY-MM-DD" -H "accept: application/json"

Right now only the MAPE metric is calculated

Available datasets:

openweather
accuweather

Example

curl -X GET "http://localhost:3000/v1/metrics/openweather?from=2022-09-28" -H "accept: application/json"

Boundary Endpoints

Get out of boundary data from a sensor from date

curl -X GET "http://localhost:3000/v1/boundaries/conductivity?from=YYYY-MM-DD1&grade={grade}" -H "accept: application/json"

Available boundaries:

conductivity
coli
ph
cod
bod
tss

Available grades for conductivity: MINOR, AVERAGE, MAJOR

Examples

curl -X GET "http://localhost:3000/v1/boundaries/conductivity?from=2022-09-15&grade=MINOR" -H "accept: application/json"

curl -X GET "http://localhost:3000/v1/boundaries/tss?from=2022-09-15" -H "accept: application/json"

Alarms Endpoints

Get the latest alarm from a sensor

curl -X GET "http://localhost:3000/v1/alarms/{sensor}" -H "accept: application/json"

Available alarms:

ph
cod
bod
tss
conductivity
coli

Example

curl -X GET "http://localhost:3000/v1/alarms/ph" -H "accept: application/json"