Het Frogwatch Dashboard heeft een publieke API gekregen. Hiermee kun je meetdata programmatisch ophalen en verwerken in je eigen systemen. In dit artikel leggen we uit wat de API is, voor wie het bedoeld is, wat je ermee kunt en hoe je ermee aan de slag gaat.
Wat is de Frogwatch Dashboard API?
De Frogwatch Dashboard API is een REST API waarmee je rechtstreeks meetdata kunt ophalen uit het Frogwatch Dashboard. De API biedt twee endpoints:
- Meetdata ophalen (GET) - Haal tijdreeksdata op voor een specifiek meetpunt en datakanaal, zoals trillingen, verplaatsing, tilt of temperatuur.
- Indicatordata uploaden (POST) - Upload indicatordata naar een meetpunt van het type 'indicator'.
De API is gedocumenteerd volgens de OpenAPI-standaard. Interactieve documentatie is beschikbaar vanuit het Dashboard zelf, inclusief voorbeeldcode in Python, Shell, Node.js, Ruby en PHP.
Voor wie is de API?
De API is bedoeld voor Frogwatch Dashboard-gebruikers die hun meetdata willen integreren in eigen systemen of workflows. Denk aan:
- Adviesbureaus die trillingsdata automatisch willen opnemen in eigen rapportagesystemen of databases.
- Ontwikkelaars die op basis van Frogwatch-data eigen dashboards, analyses of alarmering willen bouwen.
- Data-analisten die meetdata periodiek willen ophalen voor verdere analyse in tools als Python, MATLAB of Excel.
- Organisaties die API-koppelingen willen maken tussen het Frogwatch Dashboard en andere systemen, zoals een eigen monitoringplatform of projectmanagementsoftware.
Elke gebruiker met een actief Dashboard-abonnement kan gebruik maken van de API.
Wat kun je ermee?
Met het GET-endpoint kun je tijdreeksdata ophalen per meetpunt en datakanaal. Beschikbare datakanalen zijn onder andere:
- Trillingen:
vibration.x,vibration.y,vibration.z - Snelheid (SBR):
sbra_speed.x,sbra_speed.y,sbra_speed.z - Verplaatsing:
displacement - Tilt:
tilt.x,tilt.y - Temperatuur:
temperature - Rek:
strain - En diverse andere kanalen voor acceleratie, effectieve waarden en traces
Je specificeert een tijdsperiode via de from en until parameters (in UTC). Optioneel kun je downsampling in- of uitschakelen en de sorteervolgorde instellen.
Met het POST-endpoint kun je eigen indicatordata uploaden naar het Dashboard. Hiermee kun je externe meetwaarden toevoegen aan een meetpunt van het type 'indicator', zodat je deze samen met je Frogwatch-data in het Dashboard kunt bekijken.
Aan de slag
1. API-sleutel aanmaken
Een organisatiebeheerder kan een API-sleutel aanmaken via de pagina API-sleutels in het Dashboard. Deze sleutel gebruik je om je API-verzoeken te authenticeren.
2. Meetpunt-ID's opzoeken
In het Dashboard vind je onder API details in het projectmenu een overzicht van al je meetpunten, hun ID's, beschikbare datakanalen en voorbeeld-URL's. Dit maakt het eenvoudig om snel de juiste parameters voor je API-aanroepen te vinden.
3. Data ophalen
Hieronder een voorbeeld in Python om trillingsdata op te halen:
import requests
response = requests.get(
"https://api.dashboard.frog.watch/api/v1/timeseries_data/{measuring_point_id}/vibration.x",
headers={
"authorization": "YOUR_API_KEY"
},
params={
"from": "2026-03-01T00:00:00.000Z",
"until": "2026-03-02T00:00:00.000Z"
}
)
data = response.json()
# data["data"] bevat een lijst van [timestamp, waarde] paren
# data["metadata"] bevat informatie over het meetpunt en de eenheid
for timestamp, value in data["data"]:
print(f"{timestamp}: {value}")
Vervang {measuring_point_id} door het ID van je meetpunt en YOUR_API_KEY door je API-sleutel. Beide vind je in het Dashboard.
4. Interactieve documentatie
Klik op de knop API documentation op de API details-pagina om de volledige, interactieve API-documentatie te openen. Hier kun je direct API-verzoeken testen en voorbeeldcode bekijken in de programmeertaal van je keuze.
Beschikbaar voor alle Dashboard-gebruikers
De API is beschikbaar voor alle gebruikers met een actief Frogwatch Dashboard-abonnement. Heb je vragen over de API of heb je hulp nodig bij de integratie? Neem dan contact met ons op.