Skip to main content

stats

Creates, updates, deletes, gets or lists a stats resource.

Overview​

Namestats
TypeResource
Idgoogle.apigee.stats

Fields​

The following fields are returned by SELECT queries:

NameDatatypeDescription
environmentsarrayList of query results on the environment level.
hostsarrayList of query results grouped by host.
metaDataobjectMetadata information. (id: GoogleCloudApigeeV1Metadata)

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
organizations_environments_stats_getselectorganizationsId, environmentsId, statsIdaccuracy, aggTable, filter, limit, offset, realtime, select, sonar, sort, sortby, timeRange, timeUnit, topk, tsAscending, tzoRetrieve 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.

NameDatatypeDescription
environmentsIdstring
organizationsIdstring
statsIdstring
accuracystring
aggTablestring
filterstring
limitstring
offsetstring
realtimeboolean
selectstring
sonarboolean
sortstring
sortbystring
timeRangestring
timeUnitstring
topkstring
tsAscendingboolean
tzostring

SELECT examples​

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 accuracy = '{{ accuracy }}'
AND aggTable = '{{ aggTable }}'
AND filter = '{{ filter }}'
AND limit = '{{ limit }}'
AND offset = '{{ offset }}'
AND realtime = '{{ realtime }}'
AND select = '{{ select }}'
AND sonar = '{{ sonar }}'
AND sort = '{{ sort }}'
AND sortby = '{{ sortby }}'
AND timeRange = '{{ timeRange }}'
AND timeUnit = '{{ timeUnit }}'
AND topk = '{{ topk }}'
AND tsAscending = '{{ tsAscending }}'
AND tzo = '{{ tzo }}'
;