Developer API

These endpoints are still under development and are subject to change in new releases.

Summary

Resource	Operation	Description
Chart	GET /api/dev/asset/(id)	Download asset attributes for use in charts
	GET /api/dev/sensor/(id)	Download sensor attributes for use in charts
	GET /api/dev/sensor/(id)/chart	Download a chart with time series
	GET /api/dev/sensor/(id)/chart_annotations	Download annotations for use in charts
	GET /api/dev/sensor/(id)/chart_data	Download time series for use in charts

GET /api/dev/sensor/(id)/chart

GET from /sensor/<id>/chart

Optional fields

“event_starts_after” (see the timely-beliefs documentation)
“event_ends_before” (see the timely-beliefs documentation)
“beliefs_after” (see the timely-beliefs documentation)
“beliefs_before” (see the timely-beliefs documentation)
“include_data” (if true, chart specs include the data; if false, use the GET /api/dev/sensor/(id)/chart_data endpoint to fetch data)
“chart_type” (currently ‘bar_chart’ and ‘daily_heatmap’ are supported types)
“width” (an integer number of pixels; without it, the chart will be scaled to the full width of the container (hint: use <div style="width: 100%;"> to set a div width to 100%)
“height” (an integer number of pixels; without it, FlexMeasures sets a default, currently 300)

GET /api/dev/sensor/(id)/chart_annotations

GET from /sensor/<id>/chart_annotations

Annotations for use in charts (in case you have the chart specs already).

GET /api/dev/sensor/(id)/chart_data

GET from /sensor/<id>/chart_data

Data for use in charts (in case you have the chart specs already).

Optional fields

“event_starts_after” (see the timely-beliefs documentation)
“event_ends_before” (see the timely-beliefs documentation)
“beliefs_after” (see the timely-beliefs documentation)
“beliefs_before” (see the timely-beliefs documentation)
“resolution” (see resolutions)
“most_recent_beliefs_only” (if true, returns the most recent belief for each event; if false, returns each belief for each event; defaults to true)