REST Resource: gauges

  • A Gauge resource provides metadata about a physical location used for flood forecasting.

  • The JSON representation of a Gauge includes information such as location, site name, source organization, river name, country code, gauge ID, and model verification status.

  • Key fields of a Gauge include its physical location, the name of the site, the source organization responsible for the data, the river name, the country code, a unique gauge ID, a boolean indicating if the data quality is verified, and a boolean indicating if a predictive model is associated with the gauge.

  • Available methods for Gauges include batchGet to retrieve metadata for multiple gauges, get to retrieve metadata for a single gauge, queryGaugeForecasts to get forecasts, and searchGaugesByArea to find gauges within a specified geographical region.

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.