Apigee API . organizations . environments . analytics . admin

close()

Close httplib2 connections.

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

Gets a list of metrics and dimensions that can be used to create analytics queries and reports. Each schema element contains the name of the field, its associated type, and a flag indicating whether it is a standard or custom field.

Args:
  name: string, Required. Path to the schema. Use the following structure in your request: `organizations/{org}/environments/{env}/analytics/admin/schemav2`. (required)
  disableCache: boolean, Flag that specifies whether the schema is be read from the database or cache. Set to `true` to read the schema from the database. Defaults to cache.
  type: string, Required. Name of the dataset for which you want to retrieve the schema. For example: `fact` or `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 fields grouped as dimensions.
    { # Message type for the schema element
      "name": "A String", # Name of the field.
      "properties": { # Properties for the schema field. # Properties for the schema field. For example: { "createTime": "2016-02-26T10:23:09.592Z", "custom": "false", "type": "string" }
        "createTime": "A String", # Time the field was created in RFC3339 string form. For example: `2016-02-26T10:23:09.592Z`.
        "custom": "A String", # Flag that specifies whether the field is standard in the dataset or a custom field created by the customer. `true` indicates that it is a custom field.
        "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 that can be used with an aggregate function such as `sum`, `avg`, `min`, and `max`.
    { # Message type for the schema element
      "name": "A String", # Name of the field.
      "properties": { # Properties for the schema field. # Properties for the schema field. For example: { "createTime": "2016-02-26T10:23:09.592Z", "custom": "false", "type": "string" }
        "createTime": "A String", # Time the field was created in RFC3339 string form. For example: `2016-02-26T10:23:09.592Z`.
        "custom": "A String", # Flag that specifies whether the field is standard in the dataset or a custom field created by the customer. `true` indicates that it is a custom field.
        "type": "A String", # Data type of the field.
      },
    },
  ],
}