Method: gauges.get

  • The webpage provides details on retrieving metadata for a specific gauge using the Flood Forecasting API.

  • The HTTP request method for retrieving gauge data is a GET request to a specific URL endpoint.

  • A name path parameter, in the format gauges/{gaugeId}, is required to specify which gauge to retrieve.

  • The request body for this operation must be left empty.

  • A successful response will include an instance of the Gauge object containing the requested metadata.

Get metadata about a gauge.

HTTP request

GET https://floodforecasting.googleapis.com/v1/{name=gauges/*}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. The name of the gauge to retrieve. Name format: gauges/{gaugeId}.

Request body

The request body must be empty.

Response body

If successful, the response body contains an instance of Gauge.