SlicingParams

Stay organized with collections Save and categorize content based on your preferences.

Parameters that control how we slice the dataset and, optionally, filter slices that have some specific values on some dimensions (pinned dimensions).

JSON representation
{
  "dimensionNames": [
    string
  ],
  "pinnedDimensions": [
    {
      object (PinnedDimension)
    }
  ]
}
Fields
dimensionNames[]

string

Required. Dimensions over which we will group the events in slices. The names specified here come from the EventDimension.name field. At least one dimension name must be specified. All dimension names that do not exist in the queried DataSet will be ignored.

Currently only dimensions that hold string values can be specified here.

pinnedDimensions[]

object (PinnedDimension)

Optional. We will only analyze slices for which EvaluatedSlice.dimensions contain all of the following pinned dimensions. A query with a pinned dimension { name: "d3" stringVal: "v3" } will only analyze events which contain the dimension { name: "d3" stringVal: "v3" }. The pinnedDimensions and dimensionNames fields can not share the same dimension names.

Example a valid specification:

{
  dimensionNames: ["d1", "d2"],
  pinnedDimensions: [
    { name: "d3" stringVal: "v3" },
    { name: "d4" stringVal: "v4" }
  ]
}

In the previous example we will slice the dataset by dimensions "d1", "d2", "d3" and "d4", but we will only analyze slices for which "d3=v3" and "d4=v4".

The following example is invalid as "d2" is present in both dimensionNames and pinnedDimensions:

{
  dimensionNames: ["d1", "d2"],
  pinnedDimensions: [
    { name: "d2" stringVal: "v2" },
    { name: "d4" stringVal: "v4" }
  ]
}