NOTE: Some aspects of this product are in Beta. The hybrid installation options are GA. To join the Beta program, reach out to your Apigee representative.

REST Resource: organizations.environments.stats

Resource: Stats

This message type encapsulates a stats response.

JSON representation 
{
  "environments": [
    {
      object (EnvironmentStats)
    }
  ],
  "metaData": {
    object (Metadata)
  }
}
Fields
environments[]

object (EnvironmentStats)

This field contains a list of query results on environment level.
metaData

object (Metadata)

This field contains the metadata information.

EnvironmentStats

This message type encapsulates the environment wrapper: "environments": [ { "metrics": [ { "name": "sum(message_count)", "values": [ "2.52056245E8" ] } ], "name": "prod" } ]

JSON representation 
{
  "name": string,
  "metrics": [
    {
      object (Metric)
    }
  ],
  "dimensions": [
    {
      object (DimensionMetric)
    }
  ]
}
Fields
name

string
metrics[]

object (Metric)

In the final response, only one of the following fields will be present based on the dimensions provided. If no dimensions are provided, then only a top level metrics is provided. If dimensions are included, then there will be a top level dimensions field under environments which will contain metrics values and the dimension name. Example: "environments": [ { "dimensions": [ { "metrics": [ { "name": "sum(message_count)", "values": [ "2.14049521E8" ] } ], "name": "nit_proxy" } ], "name": "prod" } ]

OR
"environments": [
       {
           "metrics": [
               {
                   "name": "sum(message_count)",
                    "values": [
                       "2.19026331E8"
                   ]
               }
           ],
           "name": "prod"
       }
   ]

This field contains the list of metric values.
dimensions[]

object (DimensionMetric)

This field contains the list of metrics grouped under dimensions.

Metric

This message type encapsulates the metric data point. Example: { "name": "sum(message_count)", "values" : [ { "timestamp": 1549004400000, "value": "39.0" }, { "timestamp" : 1548997200000, "value" : "0.0" } ] } or { "name": "sum(message_count)", "values" : ["39.0"] }

JSON representation 
{
  "name": string,
  "values": array
}
Fields
name

string

This field contains the metric name.
values

array (ListValue format)

List of metric values. Possible value format: "values":["39.0"] or "values":[ { "value": "39.0", "timestamp": 1232434354} ]

DimensionMetric

This message type encapsulates a metric grouped by dimension.

JSON representation 
{
  "name": string,
  "metrics": [
    {
      object (Metric)
    }
  ]
}
Fields
name

string

This field contains the name of the dimension.
metrics[]

object (Metric)

This field contains a list of metrics.

Methods

get

 Retrieve metrics grouped by dimensions.