The NM COAST central database uses the following record elements: stations, counters, sensors, and datastreams.
The NM COAST API allows for lists of these record elements, details about a given record element, count data for a record element, or flagging checks data for a record element to be requested.
Where applicable, these requests can be filtered, where the most common filter is restricting results to fall between a given start and end date.
Count and flag data is not aggregated to the level of the record element specified.
Instead what is received is the count and flag data applied to the associated datastreams linked to the given record element.
Additionally, although not a true record element, counting-location can be used as if it was.
More information about counting-locations and why they are a useful aggregation level can be found on the section dedicated to counting-location queries.
Datastreams
Description
Route
Optional Parameters
Example Call
List all datastreams
/api/datastreams
NA
/api/datastreams
Get details about given datastream
/api/datastreams/:id
NA
/api/datastreams/103034827
Get raised flags (soft or hard) for a datastream
/api/datastreams/:id/flags
supports date filtering,
supports flag severity filtering
A counting-location consists of a counter and which side of the street (or just path if located off of a street) it is located on.
For API calls, their naming convention consists of the counter's name and the side of the street it's on (or path) joined by two underscores (e.g. APX_BCG__Path).
The use of counting-locations are valuable as a single counting location will only ever have at most 1 linked pedestrian sensor, 1 linked road cyclist sensor, and 1 linked sidewalk or path cyclist sensor.
Occasionally, a single counter might have a 2 linked road cyclists sensors (one on each side of the road).
Description
Route
Optional Parameters
Example Call
List all counting-locations
/api/counting-locations
include if unresolved flags are present (supports date filtering)
