Peaks
Schema
This page provides additional information about each field returned by this endpoint. Click "json" in the navigation
bar (or add ?f=json to this URL) to get this information in a machine-readable JSON Schema format.
| Name | Title | Type | Units | Values | Description |
|---|---|---|---|---|---|
| geometry | geometry |
|
|||
| time_series_id | Time series ID |
string
|
|
A unique identifier representing a single time series. This corresponds to the `id` field in the `time-series-metadata` endpoint. | |
| monitoring_location_id | Monitoring location ID |
string
|
|
A unique identifier representing a single monitoring location. This corresponds to the `id` field in the `monitoring-locations` endpoint. Monitoring location IDs are created by combining the agency code of the agency responsible for the monitoring location (e.g. USGS) with the ID number of the monitoring location (e.g. 02238500), separated by a hyphen (e.g. USGS-02238500). | |
| parameter_code | Parameter code |
string
|
|
Parameter codes are 5-digit codes used to identify the constituent measured and the units of measure. A complete list of parameter codes and associated groupings can be found at [https://api.waterdata.usgs.gov/ogcapi/v0/collections/parameter-codes/items](https://api.waterdata.usgs.gov/ogcapi/v0/collections/parameter-codes/items). | |
| unit_of_measure | Unit of measure |
string
|
|
A human-readable description of the units of measurement associated with an observation. | |
| value | Value |
string
|
|
The value of the observation. Values are transmitted as strings in the JSON response format in order to preserve precision. | |
| last_modified | Last modified date |
string
|
|
The last time a record was refreshed in our database. This may happen due to regular operational processes and does not necessarily indicate anything about the measurement has changed. You can query this field using date-times or intervals, adhering to RFC 3339, or using ISO 8601 duration objects. Intervals may be bounded or half-bounded (double-dots at start or end). Examples: - A date-time: "2018-02-12T23:20:50Z" - A bounded interval: "2018-02-12T00:00:00Z/2018-03-18T12:31:12Z" - Half-bounded intervals: "2018-02-12T00:00:00Z/.." or "../2018-03-18T12:31:12Z" - Duration objects: "P1M" for data from the past month or "PT36H" for the last 36 hours Only features that have a `last_modified` that intersects the value of datetime are selected. | |
| time | Time |
string
|
|
The date an observation represents. You can query this field using date-times or intervals, adhering to RFC 3339, or using ISO 8601 duration objects. Intervals may be bounded or half-bounded (double-dots at start or end). Examples: - A date-time: "2018-02-12T23:20:50Z" - A bounded interval: "2018-02-12T00:00:00Z/2018-03-18T12:31:12Z" - Half-bounded intervals: "2018-02-12T00:00:00Z/.." or "../2018-03-18T12:31:12Z" - Duration objects: "P1M" for data from the past month or "PT36H" for the last 36 hours Only features that have a `time` that intersects the value of datetime are selected. If a feature has multiple temporal properties, it is the decision of the server whether only a single temporal property is used to determine the extent or all relevant temporal properties. | |
| water_year | Water Year |
integer
|
|
The water year (running from October 1st to September 30th) a peak occurred. | |
| year | Year |
integer
|
|
The calendar year a peak occurred. | |
| month | Month |
integer
|
|
The calendar month a peak occurred. If null, the month a peak occurred is unknown. | |
| day | Day |
integer
|
|
The day of the month a peak occurred. If null, the day a peak occurred is unknown. | |
| time_of_day | Time of Day |
string (time)
|
|
The time of day a peak occurred. If null, the time of day a peak occurred is unknown. | |
| peak_since | Peak since |
integer
|
|
If not null, this record represents the peak value for the parameter code since the year contained in "peak_since". | |
| qualifier | Qualifier |
string
|
|
This field indicates any qualifiers associated with an observation, for instance if a sensor may have been impacted by ice or if values were estimated. |