Method: gauges.queryGaugeForecasts
Stay organized with collections
Save and categorize content based on your preferences.
HTTP request
GET https://floodforecasting.googleapis.com/v1/gauges:queryGaugeForecasts
The URL uses gRPC Transcoding syntax.
Query parameters
| Parameters |
gaugeIds[] |
string
Required. A list of gauge ids. The supported list size is limited to 500. If a list larger than 500 is provided it fails with an INVALID_REQUEST error.
|
issuedTimeStart |
string
Optional. The earliest forecast issued time as string (ISO 8601), e.g. "2023-06-17T10:34:00Z" or a date string e.g. "2023-10-13". Start time cannot be earlier than "2023-10-01". Default is one week ago.
|
issuedTimeEnd |
string
Optional. The latest forecast issued time as string (ISO 8601), e.g. "2023-06-17T10:34:00Z" or a date string e.g. "2023-10-13". Default is now.
|
Request body
The request body must be empty.
Response body
The response of gauges.queryGaugeForecasts.
If successful, the response body contains data with the following structure:
| JSON representation |
{
"forecasts": {
string: {
object (ForecastSet)
},
...
}
} |
| Fields |
forecasts |
map (key: string, value: object (ForecastSet))
A map from gauge id to forecast set. An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
|
ForecastSet
A set of forecasts for a gauge.
| JSON representation |
{
"forecasts": [
{
object (Forecast)
}
]
} |
| Fields |
forecasts[] |
object (Forecast)
The forecasts.
|
Forecast
A single gauge's forecast for several lead times. For example, a forecast could have issue time of 5pm, and include forecasts for 6pm, 7pm, 8pm, etc.
Note: Some of the forecast ranges can potentially be earlier than the issued time. This can happen due to e.g., lags in input data for the model. With the above example, it could be that the issue time is 5pm, and the forecast ranges are for 4pm, 5pm, 6pm, etc.
Note: Ranges vary in length, and in distance between them. Some examples of possible ranges are:
[5pm - 5pm], [6pm - 6pm], [7pm - 7pm]
[Mar 1 12am - Mar 2 12am], [Mar 2 12am - Mar 3 12am], [Mar 3 12am - Mar 4 12am]
| JSON representation |
{
"forecastRanges": [
{
object (ForecastTimedValue)
}
],
"gaugeId": string,
"issuedTime": string
} |
| Fields |
forecastRanges[] |
object (ForecastTimedValue)
A forecast consists of several "forecast ranges", which are different forecast values pertaining to different time ranges. When the start and end of a range are equal, it means it's a time instant.
|
gaugeId |
string
The ID of the gauge this forecast is for.
|
issuedTime |
string
The issued time of the forecast (ISO 8601), e.g. "2023-06-17T10:34:00Z". The issued time is the time the forecast was generated.
|
ForecastTimedValue
A forecast value pertaining to a time range. Its units are defined by the GaugeModel it is associated with. If the start and end are equal, it means it's a time instant.
| JSON representation |
{
"value": number,
"forecastStartTime": string,
"forecastEndTime": string
} |
| Fields |
value |
number
The value of the forecast.
|
forecastStartTime |
string
The start of the interval.
|
forecastEndTime |
string
The end of the interval.
|
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 page documents the \u003ccode\u003equeryGaugeForecasts\u003c/code\u003e method, which retrieves forecast data for specified gauges via an HTTP GET request.\u003c/p\u003e\n"],["\u003cp\u003eThe request requires a list of \u003ccode\u003egaugeIds\u003c/code\u003e, and optionally accepts \u003ccode\u003eissuedTimeStart\u003c/code\u003e and \u003ccode\u003eissuedTimeEnd\u003c/code\u003e parameters to filter forecasts by issue time, with default values of one week ago and now, respectively.\u003c/p\u003e\n"],["\u003cp\u003eThe response body is structured as a map of \u003ccode\u003egaugeId\u003c/code\u003e to \u003ccode\u003eForecastSet\u003c/code\u003e, where each \u003ccode\u003eForecastSet\u003c/code\u003e contains an array of \u003ccode\u003eForecast\u003c/code\u003e objects.\u003c/p\u003e\n"],["\u003cp\u003eEach \u003ccode\u003eForecast\u003c/code\u003e contains an array of \u003ccode\u003eForecastTimedValue\u003c/code\u003e objects, representing forecast values for different time ranges, along with the \u003ccode\u003egaugeId\u003c/code\u003e and the \u003ccode\u003eissuedTime\u003c/code\u003e of the forecast.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eForecastTimedValue\u003c/code\u003e objects represent forecast values within a specific time range, including the \u003ccode\u003evalue\u003c/code\u003e, \u003ccode\u003eforecastStartTime\u003c/code\u003e, and \u003ccode\u003eforecastEndTime\u003c/code\u003e, with equal start and end times indicating a time instant.\u003c/p\u003e\n"]]],[],null,["# Method: gauges.queryGaugeForecasts\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.QueryGaugeForecastsResponse.SCHEMA_REPRESENTATION)\n- [ForecastSet](#ForecastSet)\n - [JSON representation](#ForecastSet.SCHEMA_REPRESENTATION)\n- [Forecast](#Forecast)\n - [JSON representation](#Forecast.SCHEMA_REPRESENTATION)\n- [ForecastTimedValue](#ForecastTimedValue)\n - [JSON representation](#ForecastTimedValue.SCHEMA_REPRESENTATION)\n\nQuery gauge forecasts.\n\n### HTTP request\n\n`GET https://floodforecasting.googleapis.com/v1/gauges:queryGaugeForecasts`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Query parameters\n\n| Parameters ||\n|-------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `gaugeIds[]` | `string` Required. A list of gauge ids. The supported list size is limited to 500. If a list larger than 500 is provided it may fail, and soon we will also enforce the limit by returning an INVALID_REQUEST error. |\n| `issuedTimeStart` | `string` Optional. The earliest forecast issued time as string (ISO 8601), e.g. \"2023-06-17T10:34:00Z\" or a date string e.g. \"2023-10-13\". Start time cannot be earlier than \"2023-10-01\". Default is one week ago. |\n| `issuedTimeEnd` | `string` Optional. The latest forecast issued time as string (ISO 8601), e.g. \"2023-06-17T10:34:00Z\" or a date string e.g. \"2023-10-13\". Default is now. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nThe response of gauges.queryGaugeForecasts.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|--------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"forecasts\": { string: { object (/flood-forecasting/rest/v1/gauges/queryGaugeForecasts#ForecastSet) }, ... } } ``` |\n\n| Fields ||\n|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `forecasts` | `map (key: string, value: object (`[ForecastSet](/flood-forecasting/rest/v1/gauges/queryGaugeForecasts#ForecastSet)`))` A map from gauge id to forecast set. An object containing a list of `\"key\": value` pairs. Example: `{ \"name\": \"wrench\", \"mass\": \"1.3kg\", \"count\": \"3\" }`. |\n\nForecastSet\n-----------\n\nA set of forecasts for a gauge.\n\n| JSON representation |\n|----------------------------------------------------------------------------------------------------------|\n| ``` { \"forecasts\": [ { object (/flood-forecasting/rest/v1/gauges/queryGaugeForecasts#Forecast) } ] } ``` |\n\n| Fields ||\n|---------------|--------------------------------------------------------------------------------------------------------|\n| `forecasts[]` | `object (`[Forecast](/flood-forecasting/rest/v1/gauges/queryGaugeForecasts#Forecast)`)` The forecasts. |\n\nForecast\n--------\n\nA single gauge's forecast for several lead times. For example, a forecast could have issue time of 5pm, and include forecasts for 6pm, 7pm, 8pm, etc.\n\nNote: Some of the forecast ranges can potentially be earlier than the issued time. This can happen due to e.g., lags in input data for the model. With the above example, it could be that the issue time is 5pm, and the forecast ranges are for 4pm, 5pm, 6pm, etc.\n\nNote: Ranges vary in length, and in distance between them. Some examples of possible ranges are:\n\n1. \\[5pm - 5pm\\], \\[6pm - 6pm\\], \\[7pm - 7pm\\]\n\n2. \\[Mar 1 12am - Mar 2 12am\\], \\[Mar 2 12am - Mar 3 12am\\], \\[Mar 3 12am - Mar 4 12am\\]\n\n| JSON representation |\n|------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"forecastRanges\": [ { object (/flood-forecasting/rest/v1/gauges/queryGaugeForecasts#ForecastTimedValue) } ], \"gaugeId\": string, \"issuedTime\": string } ``` |\n\n| Fields ||\n|--------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `forecastRanges[]` | `object (`[ForecastTimedValue](/flood-forecasting/rest/v1/gauges/queryGaugeForecasts#ForecastTimedValue)`)` A forecast consists of several \"forecast ranges\", which are different forecast values pertaining to different time ranges. When the start and end of a range are equal, it means it's a time instant. |\n| `gaugeId` | `string` The ID of the gauge this forecast is for. |\n| `issuedTime` | `string` The issued time of the forecast (ISO 8601), e.g. \"2023-06-17T10:34:00Z\". The issued time is the time the forecast was generated. |\n\nForecastTimedValue\n------------------\n\nA forecast value pertaining to a time range. Its units are defined by the GaugeModel it is associated with. If the start and end are equal, it means it's a time instant.\n\n| JSON representation |\n|-------------------------------------------------------------------------------------|\n| ``` { \"value\": number, \"forecastStartTime\": string, \"forecastEndTime\": string } ``` |\n\n| Fields ||\n|---------------------|-------------------------------------|\n| `value` | `number` The value of the forecast. |\n| `forecastStartTime` | `string` The start of the interval. |\n| `forecastEndTime` | `string` The end of the interval. |"]]