Method: gauges.batchGet

AI-generated Key Takeaways

• This endpoint retrieves metadata for multiple gauges using a GET request to https://floodforecasting.googleapis.com/v1/gauges:batchGet.

• You must provide a list of gauge names using the names[] query parameter, following the format gauges/{gaugeId}.

• The request body should be empty when making the call to retrieve gauge data.

• The successful response contains a JSON object with an array named gauges, where each element is a Gauge object containing metadata about the requested gauges.

• HTTP request
• Query parameters
• Request body
• Response body
  • JSON representation

Get metadata about multiple gauges.

HTTP request

GET https://floodforecasting.googleapis.com/v1/gauges:batchGet

The URL uses gRPC Transcoding syntax.

Query parameters

Parameters
names[]	string Required. The gauge names to retrieve. Name format: gauges/{gaugeId}. The supported list size is limited to 100,000. If a list larger than 100,000 is provided it fails with an INVALID_REQUEST error.

Request body

The request body must be empty.

Response body

The response of gauges.batchGet.

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

JSON representation
{ "gauges": [ { object (Gauge) } ] }

Fields
gauges[]	object (Gauge) The requested gauges.