Method: floodStatus.searchLatestFloodStatusByArea
Stay organized with collections
Save and categorize content based on your preferences.
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.
|
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-09-01 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-01 UTC."],[[["\u003cp\u003eThis endpoint retrieves the latest flood statuses for a specified geographical area, focusing on the locations of the gauges within the area.\u003c/p\u003e\n"],["\u003cp\u003eThe request is made using a POST HTTP method to the provided URL, \u003ccode\u003ehttps://floodforecasting.googleapis.com/v1/floodStatus:searchLatestFloodStatusByArea\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eThe request body must include either a \u003ccode\u003eregionCode\u003c/code\u003e or a \u003ccode\u003eloop\u003c/code\u003e to define the geographical area for the flood status search.\u003c/p\u003e\n"],["\u003cp\u003eThe response body contains an array of \u003ccode\u003efloodStatuses\u003c/code\u003e, providing details on the latest flood statuses within the specified area.\u003c/p\u003e\n"],["\u003cp\u003eThere is an optional boolean parameter \u003ccode\u003eincludeNonQualityVerified\u003c/code\u003e that can be set to true to also include non-quality-verified gauges.\u003c/p\u003e\n"]]],[],null,["- [HTTP request](#body.HTTP_TEMPLATE)\n- [Request body](#body.request_body)\n - [JSON representation](#body.request_body.SCHEMA_REPRESENTATION)\n- [Response body](#body.response_body)\n - [JSON representation](#body.SearchLatestFloodStatusByAreaResponse.SCHEMA_REPRESENTATION)\n\nSearch 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.\n\nHTTP request\n\n`POST https://floodforecasting.googleapis.com/v1/floodStatus:searchLatestFloodStatusByArea`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\nRequest body\n\nThe request body contains data with the following structure:\n\n| JSON representation |\n|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"pageToken\": string, \"pageSize\": integer, // Union field `area_type` can be only one of the following: \"regionCode\": string, \"loop\": { object (/flood-forecasting/rest/v1/Loop) } // End of list of possible types for union field `area_type`. \"includeNonQualityVerified\": boolean } ``` |\n\n| Fields ||\n|-----------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `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. |\n| `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. |\n| Union field `area_type`. `area_type` can be only one of the following: ||\n| `regionCode` | `string` The region by which to query flood statuses. Using CLDR, e.g., 'US'. |\n| `loop` | `object (`[Loop](/flood-forecasting/rest/v1/Loop)`)` The loop by which to query flood statuses. |\n| `includeNonQualityVerified` | `boolean` Optional. Include in the result gauges that aren't quality verified. Please use with caution. Default is false. |\n\nResponse body The response of floodStatus.searchLatestFloodStatusByArea.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|---------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"floodStatuses\": [ { object (/flood-forecasting/rest/v1/floodStatus#FloodStatus) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|-------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `floodStatuses[]` | `object (`[FloodStatus](/flood-forecasting/rest/v1/floodStatus#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. |\n| `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. |"]]