Method: gauges.queryGaugeForecasts

Query gauge forecasts.

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 may fail, and soon we will also enforce the limit by returning 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:

  1. [5pm - 5pm], [6pm - 6pm], [7pm - 7pm]

  2. [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.