Documentation

Google_Service_Apigee_Resource_OrganizationsEnvironmentsStats extends Google_Service_Resource
in package

The "stats" collection of methods.

Typical usage is: $apigeeService = new Google_Service_Apigee(...); $stats = $apigeeService->stats;

Table of Contents

$client  : Google_Client
$methods  : array<string|int, mixed>
$resourceName  : string
$rootUrl  : string
$serviceName  : string
$servicePath  : string
$stackParameters  : mixed
__construct()  : mixed
call()  : Google_Http_Request|expectedClass
TODO: This function needs simplifying.
createRequestUri()  : string
Parse/expand request parameters and create a fully qualified request uri.
get()  : Google_Service_Apigee_GoogleCloudApigeeV1Stats
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. The stats api does accept dimensions as path params. The dimensions are optional in which case the metrics are computed on the entire data for the given timerange. (stats.get)
convertToArrayAndStripNulls()  : mixed

Properties

$methods

private array<string|int, mixed> $methods

$resourceName

private string $resourceName

$serviceName

private string $serviceName

$servicePath

private string $servicePath

$stackParameters

private mixed $stackParameters = array('alt' => array('type' => 'string', 'location' => 'query'), 'fields' => array('type' => 'string', 'location' => 'query'), 'trace' => array('type' => 'string', 'location' => 'query'), 'userIp' => array('type' => 'string', 'location' => 'query'), 'quotaUser' => array('type' => 'string', 'location' => 'query'), 'data' => array('type' => 'string', 'location' => 'body'), 'mimeType' => array('type' => 'string', 'location' => 'header'), 'uploadType' => array('type' => 'string', 'location' => 'query'), 'mediaUpload' => array('type' => 'complex', 'location' => 'query'), 'prettyPrint' => array('type' => 'string', 'location' => 'query'))

Methods

__construct()

public __construct(mixed $service, mixed $serviceName, mixed $resourceName, mixed $resource) : mixed
Parameters
$service : mixed
$serviceName : mixed
$resourceName : mixed
$resource : mixed
Return values
mixed —

call()

TODO: This function needs simplifying.

public call( $name,  $arguments[,  $expectedClass = null ]) : Google_Http_Request|expectedClass
Parameters
$name :
$arguments :
$expectedClass : = null
  • optional, the expected class name
Tags
throws
Google_Exception
Return values
Google_Http_Request|expectedClass —

createRequestUri()

Parse/expand request parameters and create a fully qualified request uri.

public createRequestUri(string $restPath, array<string|int, mixed> $params) : string
Parameters
$restPath : string
$params : array<string|int, mixed>
Tags
static
Return values
string —

$requestUrl

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. The stats api does accept dimensions as path params. The dimensions are optional in which case the metrics are computed on the entire data for the given timerange. (stats.get)

public get(string $name[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Apigee_GoogleCloudApigeeV1Stats
Parameters
$name : string

Required. The resource name for which the interactive query will be executed. Must be of the form organizations/{organization_id}/ environments/{environment_id/stats/{dimensions} Dimensions let you view metrics in meaningful groupings. E.g. apiproxy, target_host. The value of dimensions should be comma separated list as shown below organizations/{org}/environments/{env}/stats/apiproxy,request_verb

$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

string accuracy Legacy field: not used anymore. This field is present to support UI calls which still use this parameter.

opt_param

string sortby Comma separated list of columns to sort the final result.

opt_param

bool tsAscending Lists timestamps in ascending order if set to true. Recommend setting this value to true if you are using sortby with sort=DESC.

opt_param

string aggTable If customers want to query custom aggregate tables, then this parameter can be used to specify the table name. If this parameter is skipped, then Edge Query will try to retrieve the data from fact tables which will be expensive.

opt_param

string sort This parameter specifies if the sort order should be ascending or descending Supported values are DESC and ASC.

opt_param

string tzo This parameters contains the timezone offset value.

opt_param

string timeUnit A value of second, minute, hour, day, week, month. Time Unit specifies the granularity of metrics returned.

opt_param

string select The select parameter contains a comma separated list of metrics. E.g. sum(message_count),sum(error_count)

opt_param

string offset Use offset with limit to enable pagination of results. For example, to display results 11-20, set limit to '10' and offset to '10'.

opt_param

bool sonar This parameter routes the query to api monitoring service for last hour.

opt_param

string limit This parameter is used to limit the number of result items. Default and the max value is 14400.

opt_param

string timeRange Time interval for the interactive query. Time range is specified as start~end E.g. 04/15/2017 00:00~05/15/2017 23:59

opt_param

bool realtime Legacy field: not used anymore.

opt_param

string topk Take 'top k' results from results, for example, to return the top 5 results 'topk=5'.

opt_param

string filter Enables drill-down on specific dimension values

Return values
Google_Service_Apigee_GoogleCloudApigeeV1Stats —

convertToArrayAndStripNulls()

protected convertToArrayAndStripNulls(mixed $o) : mixed
Parameters
$o : mixed
Return values
mixed —

Search results