Method: gauges.batchGet
Stay organized with collections
Save and categorize content based on your preferences.
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.
|
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 metadata for multiple gauges using a \u003ccode\u003eGET\u003c/code\u003e request to \u003ccode\u003ehttps://floodforecasting.googleapis.com/v1/gauges:batchGet\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eYou must provide a list of gauge names using the \u003ccode\u003enames[]\u003c/code\u003e query parameter, following the format \u003ccode\u003egauges/{gaugeId}\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eThe request body should be empty when making the call to retrieve gauge data.\u003c/p\u003e\n"],["\u003cp\u003eThe successful response contains a JSON object with an array named \u003ccode\u003egauges\u003c/code\u003e, where each element is a Gauge object containing metadata about the requested gauges.\u003c/p\u003e\n"]]],[],null,["# Method: gauges.batchGet\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.BatchGetGaugesResponse.SCHEMA_REPRESENTATION)\n\nGet metadata about multiple gauges.\n\n### HTTP request\n\n`GET https://floodforecasting.googleapis.com/v1/gauges:batchGet`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Query parameters\n\n| Parameters ||\n|-----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `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 may fail, and soon we will also enforce the limit by returning an INVALID_REQUEST error. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nThe response of gauges.batchGet.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|--------------------------------------------------------------------------------|\n| ``` { \"gauges\": [ { object (/flood-forecasting/rest/v1/gauges#Gauge) } ] } ``` |\n\n| Fields ||\n|------------|-------------------------------------------------------------------------------------|\n| `gauges[]` | `object (`[Gauge](/flood-forecasting/rest/v1/gauges#Gauge)`)` The requested gauges. |"]]