Method: floodStatus.searchLatestFloodStatusByArea

  • This endpoint retrieves the latest flood statuses for a specified geographical area, focusing on the locations of the gauges within the area.

  • The request is made using a POST HTTP method to the provided URL, https://floodforecasting.googleapis.com/v1/floodStatus:searchLatestFloodStatusByArea.

  • The request body must include either a regionCode or a loop to define the geographical area for the flood status search.

  • The response body contains an array of floodStatuses, providing details on the latest flood statuses within the specified area.

  • There is an optional boolean parameter includeNonQualityVerified that can be set to true to also include non-quality-verified gauges.

Search latest flood status by geographical area. Note: Returns flood statuses whose gauge is within the given area, as opposed to e.g., affected area intersecting with the given area. This is subject to change in the future.

HTTP request

POST https://floodforecasting.googleapis.com/v1/floodStatus:searchLatestFloodStatusByArea

The URL uses gRPC Transcoding syntax.

Request body

The request body contains data with the following structure:

JSON representation 
{
  "pageToken": string,
  "pageSize": integer,

  // Union field area_type can be only one of the following:
  "regionCode": string,
  "loop": {
    object (Loop)
  }
  // End of list of possible types for union field area_type.
  "includeNonQualityVerified": boolean
}
Fields
pageToken

string

Optional. A page token, received from a previous floodStatus.searchLatestFloodStatusByArea call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to floodStatus.searchLatestFloodStatusByArea must match the call that provided the page token.
pageSize

integer

Optional. The maximum number of flood statuses to return. The service may return fewer than this value. If unspecified, at most 20,000 flood statuses will be returned. The maximum value is 20,000; values above 20,000 will be coerced to 20,000.

Union field area_type.

area_type can be only one of the following:
regionCode

string

The region by which to query flood statuses. Using CLDR, e.g., 'US'.
loop

object (Loop)

The loop by which to query flood statuses.
includeNonQualityVerified

boolean

Optional. Include in the result gauges that aren't quality verified. Please use with caution. Default is false.

Response body

The response of floodStatus.searchLatestFloodStatusByArea.

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

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

object (FloodStatus)

The latest flood statuses in the requested area. Currently, this is determined by the location of the gauges, this is subject to change in the future.
nextPageToken

string

Optional. A token that can be sent as pageToken to retrieve the next page. If this field is omitted, there are no subsequent pages.