Retrieve metrics grouped by dimensions in host level. The types of metrics you can retrieve include traffic, message counts, API call latency, response size, and cache hits and counts.
Dimensions let you view metrics in meaningful groups. You can optionally pass dimensions as path parameters to thestatsAPI. If dimensions are not specified, the metrics are computed on the entire set of data for the given time range.
HTTP request
GET https://apigee.googleapis.com/v1/{name=organizations/*/hostStats/**}
Required. Resource name for which the interactive query will be executed. Use the following format in your request:organizations/{org}/hostStats/{dimensions}
Dimensions let you view metrics in meaningful groupings, such asapiproxy,target_host. The value of dimensions should be a comma-separated list as shown beloworganizations/{org}/hostStats/apiproxy,request_verb
Authorization requires the followingIAMpermission on the specified resourcename:
apigee.hoststats.get
Query parameters
Parameters
select
string
Comma-separated list of metrics. For example:sum(message_count),sum(error_count)
timeUnit
string
Granularity of metrics returned. Valid values include:second,minute,hour,day,week, ormonth.
timeRange
string
Time interval for the interactive query. Time range is specified in GMT asstart~end. For example:04/15/2017 00:00~05/15/2017 23:59
filter
string
Flag that enables drill-down on specific dimension values.
sort
string
Flag that specifies if the sort order should be ascending or descending. Valid values areDESCandASC.
sortby
string
Comma-separated list of metrics to sort the final result.
limit
string
Maximum number of result items to return.
offset
string
Offset value. Useoffsetwithlimitto enable pagination of results. For example, to display results 11-20, set limit to10and offset to10.
topk
string
Top number of results to return. For example, to return the top 5 results, settopk=5.
tsAscending
boolean
Flag that specifies whether to list timestamps in ascending (true) or descending (false) order. Apigee recommends that you set this value totrueif you are usingsortbywithsort=DESC.
realtime
boolean
No longer used by Apigee. Supported for backwards compatibility.
tzo
string
Timezone offset value.
accuracy
string
No longer used by Apigee. Supported for backwards compatibility.
envgroupHostname
string
Required. Hostname for which the interactive query will be executed.
Request body
The request body must be empty.
Response body
If successful, the response body contains an instance ofStats.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[[["\u003cp\u003eThis API allows you to retrieve metrics such as traffic, message counts, API call latency, response size, and cache hits at the host level, grouped by specified dimensions.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003ename\u003c/code\u003e path parameter, required for the request, defines the resource and dimensions for metric grouping, following the format \u003ccode\u003eorganizations/{org}/hostStats/{dimensions}\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eQuery parameters provide control over data selection, granularity, time range, filtering, sorting, limiting, pagination, top results, and timezone, including \u003ccode\u003eselect\u003c/code\u003e, \u003ccode\u003etimeUnit\u003c/code\u003e, \u003ccode\u003etimeRange\u003c/code\u003e, \u003ccode\u003esort\u003c/code\u003e, and more.\u003c/p\u003e\n"],["\u003cp\u003eThe HTTP request is a \u003ccode\u003eGET\u003c/code\u003e method to the URL \u003ccode\u003ehttps://apigee.googleapis.com/v1/{name=organizations/*/hostStats/**}\u003c/code\u003e, and the request body is expected to be empty, while the response body will contain an instance of Stats.\u003c/p\u003e\n"],["\u003cp\u003eAuthorization to use this API requires the OAuth scope: \u003ccode\u003ehttps://www.googleapis.com/auth/cloud-platform\u003c/code\u003e.\u003c/p\u003e\n"]]],[],null,["# Method: organizations.hostStats.get\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nRetrieve metrics grouped by dimensions in host level. The types of metrics you can retrieve include traffic, message counts, API call latency, response size, and cache hits and counts.\n\nDimensions let you view metrics in meaningful groups. You can optionally pass dimensions as path parameters to the `stats` API. If dimensions are not specified, the metrics are computed on the entire set of data for the given time range.\n\n### HTTP request\n\n`GET https://apigee.googleapis.com/v1/{name=organizations/*/hostStats/**}`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n### Query parameters\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nIf successful, the response body contains an instance of [Stats](/apigee/docs/reference/apis/apigee/rest/v1/organizations.environments.stats#Stats).\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/cloud-platform`"]]
