google_api_apigee v0.11.0 GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1Query View Source

Attributes

  • csvDelimiter (type: String.t, default: nil) - Delimiter used in the CSV file, if outputFormat is set to csv. Defaults to the , (comma) character. Supported delimiter characters include comma (,), pipe (|), and tab (\t).

  • dimensions (type: list(String.t), default: nil) - A list of dimensions. https://docs.apigee.com/api-platform/analytics/analytics-reference#dimensions

  • filter (type: String.t, default: nil) - Boolean expression that can be used to filter data. Filter expressions can be combined using AND/OR terms and should be fully parenthesized to avoid ambiguity. See Analytics metrics, dimensions, and filters reference https://docs.apigee.com/api-platform/analytics/analytics-reference for more information on the fields available to filter on. For more information on the tokens that you use to build filter expressions, see Filter expression syntax. https://docs.apigee.com/api-platform/analytics/asynch-reports-api#filter-expression-syntax

  • groupByTimeUnit (type: String.t, default: nil) - Time unit used to group the result set. Valid values include: second, minute, hour, day, week, or month. If a query includes groupByTimeUnit, then the result is an aggregation based on the specified time unit and the resultant timestamp does not include milliseconds precision. If a query omits groupByTimeUnit, then the resultant timestamp includes milliseconds precision.

  • limit (type: integer(), default: nil) - Maximum number of rows that can be returned in the result.

  • metrics (type: list(GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1QueryMetric.t), default: nil) - A list of Metrics.

  • name (type: String.t, default: nil) - Asynchronous Query Name.

  • outputFormat (type: String.t, default: nil) - Valid values include: csv or json. Defaults to json. Note: Configure the delimiter for CSV output using the csvDelimiter property.

  • reportDefinitionId (type: String.t, default: nil) - Asynchronous Report ID.

  • timeRange (type: any(), default: nil) - Required. Time range for the query. Can use the following predefined strings to specify the time range: last60minutes last24hours last7days Or, specify the timeRange as a structure describing start and end timestamps in the ISO format: yyyy-mm-ddThh:mm:ssZ.

    Example: "timeRange": {

    "start": "2018-07-29T00:13:00Z",
    "end": "2018-08-01T00:18:00Z"

    }

Link to this section Summary

Functions

Unwrap a decoded JSON object into its complex fields.

Link to this section Types

Specs

t() :: %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1Query{
  csvDelimiter: String.t(),
  dimensions: [String.t()],
  filter: String.t(),
  groupByTimeUnit: String.t(),
  limit: integer(),
  metrics: [GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1QueryMetric.t()],
  name: String.t(),
  outputFormat: String.t(),
  reportDefinitionId: String.t(),
  timeRange: any()
}

Link to this section Functions

Specs

decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.