Method: floodStatus.queryLatestFloodStatusByGaugeIds

  • The API endpoint for querying the latest flood status by gauge IDs is GET https://floodforecasting.googleapis.com/v1/floodStatus:queryLatestFloodStatusByGaugeIds.

  • To query, a list of gauge IDs is required and must be provided as gaugeIds[] in the query parameters.

  • The request body for this API must be empty, and no data should be provided within it.

  • A successful response returns an array of floodStatuses, where each element is a FloodStatus object containing the latest flood status information for a requested gauge.

Query latest flood status by gauge ids.

HTTP request

GET https://floodforecasting.googleapis.com/v1/floodStatus:queryLatestFloodStatusByGaugeIds

The URL uses gRPC Transcoding syntax.

Query parameters

Parameters
gaugeIds[]

string

Required. A list of gauge ids. The supported list size is limited to 20,000. If a list larger than 20,000 is provided it fails with an INVALID_REQUEST error.

Request body

The request body must be empty.

Response body

The response of floodStatus.queryLatestFloodStatusByGaugeIds.

If successful, the response body contains data with the following structure:

JSON representation 
{
  "floodStatuses": [
    {
      object (FloodStatus)
    }
  ]
}
Fields
floodStatuses[]

object (FloodStatus)

The latest flood statuses for the requested gauges.