stats
Creates, updates, deletes, gets or lists a stats
resource.
Overview
Name | stats |
Type | Resource |
Id | google.apigee.stats |
Fields
The following fields are returned by SELECT
queries:
- organizations_environments_stats_get
Successful response
Name | Datatype | Description |
---|---|---|
environments | array | List of query results on the environment level. |
hosts | array | List of query results grouped by host. |
metaData | object | Metadata information. (id: GoogleCloudApigeeV1Metadata) |
Methods
The following methods are available for this resource:
Name | Accessible by | Required Params | Optional Params | Description |
---|---|---|---|---|
organizations_environments_stats_get | select | organizationsId , environmentsId , statsId | select , timeUnit , timeRange , filter , sort , sortby , aggTable , limit , offset , topk , tsAscending , realtime , sonar , tzo , accuracy | Retrieve metrics grouped by dimensions. 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 the stats API. If dimensions are not specified, the metrics are computed on the entire set of data for the given time range. |
Parameters
Parameters can be passed in the WHERE
clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
Name | Datatype | Description |
---|---|---|
environmentsId | string | |
organizationsId | string | |
statsId | string | |
accuracy | string | |
aggTable | string | |
filter | string | |
limit | string | |
offset | string | |
realtime | boolean | |
select | string | |
sonar | boolean | |
sort | string | |
sortby | string | |
timeRange | string | |
timeUnit | string | |
topk | string | |
tsAscending | boolean | |
tzo | string |
SELECT
examples
- organizations_environments_stats_get
Retrieve metrics grouped by dimensions. 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 the stats
API. If dimensions are not specified, the metrics are computed on the entire set of data for the given time range.
SELECT
environments,
hosts,
metaData
FROM google.apigee.stats
WHERE organizationsId = '{{ organizationsId }}' -- required
AND environmentsId = '{{ environmentsId }}' -- required
AND statsId = '{{ statsId }}' -- required
AND select = '{{ select }}'
AND timeUnit = '{{ timeUnit }}'
AND timeRange = '{{ timeRange }}'
AND filter = '{{ filter }}'
AND sort = '{{ sort }}'
AND sortby = '{{ sortby }}'
AND aggTable = '{{ aggTable }}'
AND limit = '{{ limit }}'
AND offset = '{{ offset }}'
AND topk = '{{ topk }}'
AND tsAscending = '{{ tsAscending }}'
AND realtime = '{{ realtime }}'
AND sonar = '{{ sonar }}'
AND tzo = '{{ tzo }}'
AND accuracy = '{{ accuracy }}';