Apigee API . organizations . environments . analytics . admin

Instance Methods

close()

Close httplib2 connections.

getSchemav2(name, type=None, x__xgafv=None)

Get a list of metrics and dimensions which can be used for creating analytics queries and reports. Each schema element contains the name of the field with its associated type and if it is either custom field or standard field.

Method Details

close()
Close httplib2 connections.
getSchemav2(name, type=None, x__xgafv=None)
Get a list of metrics and dimensions which can be used for creating analytics queries and reports. Each schema element contains the name of the field with its associated type and if it is either custom field or standard field.

Args:
  name: string, Required. The parent organization and environment names. Must be of the form `organizations/{org}/environments/{env}/analytics/admin/schemav2`. (required)
  type: string, Required. Type refers to the dataset name whose schema needs to be retrieved E.g. type=fact or type=agg_cus1
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response for Schema call
  "dimensions": [ # List of schema fiels grouped as dimensions.
    { # Message type for the schema element
      "name": "A String", # Name of the field
      "properties": { # Message type for schema property # Property of the schema field E.g. { "createTime": "2016-02-26T10:23:09.592Z", "custom": "false", "type": "string" }
        "createTime": "A String", # Creation time of the field
        "custom": "A String", # Custom is a flag signifying if the field was provided as part of the standard dataset or a custom field created by the customer
        "type": "A String", # Data type of the field.
      },
    },
  ],
  "meta": [ # Additional metadata associated with schema. This is a legacy field and usually consists of an empty array of strings.
    "A String",
  ],
  "metrics": [ # List of schema fields grouped as dimensions. These are fields that can be used with an aggregate function such as sum, avg, min, max.
    { # Message type for the schema element
      "name": "A String", # Name of the field
      "properties": { # Message type for schema property # Property of the schema field E.g. { "createTime": "2016-02-26T10:23:09.592Z", "custom": "false", "type": "string" }
        "createTime": "A String", # Creation time of the field
        "custom": "A String", # Custom is a flag signifying if the field was provided as part of the standard dataset or a custom field created by the customer
        "type": "A String", # Data type of the field.
      },
    },
  ],
}