REST Resource: gauges

  • The Gauge resource provides metadata about a specific gauge, including its location, site name, data source, river, country code, and unique ID.

  • The JSON representation of a Gauge includes fields such as location, siteName, source, river, countryCode, gaugeId, qualityVerified, and hasModel, each with specific data types and meanings.

  • The qualityVerified field indicates if a gauge's model (if present) is quality-verified, and hasModel indicates the existence of a model for the gauge.

  • There are four methods available to interact with gauge data: batchGet, get, queryGaugeForecasts, and searchGaugesByArea, allowing for retrieval of metadata, forecasts, and searching gauges within a specified area.

  • The Gauge resource location is a LatLng object, and you can find more info on it by looking at the provided link.

Resource: Gauge

Metadata of a gauge.

JSON representation 
{
  "location": {
    object (LatLng)
  },
  "siteName": string,
  "source": string,
  "river": string,
  "countryCode": string,
  "gaugeId": string,
  "qualityVerified": boolean,
  "hasModel": boolean
}
Fields
location

object (LatLng)

The physical location of the gauge.
siteName

string

The name of the site at which this gauge is located, in English. This is not a unique identifier; there may be several gauges in nearby locations with the same site name. Not always present.
source

string

The organization responsible for the data of this gauge, e.g. GRDC, CWC, etc.
river

string

The gauge's river name in English. Not always present.
countryCode

string

The country code of the gauge's country (ISO 3166 Alpha-2).
gaugeId

string

The ID of the gauge.
qualityVerified

boolean

This field is true if the gauge does not have a model, or if it has a model and the model is quality-verified. Please use with caution when this value is set to false.
hasModel

boolean

This field is true if the gauge has a model. If the gauge has a model, it's possible to get this gauges's GaugeModel using gaugeModels.get or gaugeModels.batchGet. And also getting its forecasts using gauges.queryGaugeForecasts.

Methods

batchGet

 Get metadata about multiple gauges.

get

 Get metadata about a gauge.

queryGaugeForecasts

 Query gauge forecasts.

searchGaugesByArea

 Search for gauges by geographical area.