RunPivotReportResponse

The response pivot report table corresponding to a pivot request.

JSON representation
{
  "pivotHeaders": [
    {
      object (PivotHeader)
    }
  ],
  "dimensionHeaders": [
    {
      object (DimensionHeader)
    }
  ],
  "metricHeaders": [
    {
      object (MetricHeader)
    }
  ],
  "rows": [
    {
      object (Row)
    }
  ],
  "aggregates": [
    {
      object (Row)
    }
  ],
  "metadata": {
    object (ResponseMetaData)
  },
  "propertyQuota": {
    object (PropertyQuota)
  },
  "kind": string
}
Fields
pivotHeaders[]

object (PivotHeader)

Summarizes the columns and rows created by a pivot. Each pivot in the request produces one header in the response. If we have a request like this:

"pivots": [{
  "fieldNames": ["country",
    "city"]
},
{
  "fieldNames": "eventName"
}]

We will have the following pivotHeaders in the response:

"pivotHeaders" : [{
  "dimensionHeaders": [{
    "dimensionValues": [
       { "value": "United Kingdom" },
       { "value": "London" }
     ]
  },
  {
    "dimensionValues": [
    { "value": "Japan" },
    { "value": "Osaka" }
    ]
  }]
},
{
  "dimensionHeaders": [{
    "dimensionValues": [{ "value": "session_start" }]
  },
  {
    "dimensionValues": [{ "value": "scroll" }]
  }]
}]
dimensionHeaders[]

object (DimensionHeader)

Describes dimension columns. The number of DimensionHeaders and ordering of DimensionHeaders matches the dimensions present in rows.

metricHeaders[]

object (MetricHeader)

Describes metric columns. The number of MetricHeaders and ordering of MetricHeaders matches the metrics present in rows.

rows[]

object (Row)

Rows of dimension value combinations and metric values in the report.

aggregates[]

object (Row)

Aggregation of metric values. Can be totals, minimums, or maximums. The returned aggregations are controlled by the metricAggregations in the pivot. The type of aggregation returned in each row is shown by the dimensionValues which are set to "RESERVED_".

metadata

object (ResponseMetaData)

Metadata for the report.

propertyQuota

object (PropertyQuota)

This Analytics Property's quota state including this request.

kind

string

Identifies what kind of resource this message is. This kind is always the fixed string "analyticsData#runPivotReport". Useful to distinguish between response types in JSON.

PivotHeader

Dimensions' values in a single pivot.

JSON representation
{
  "pivotDimensionHeaders": [
    {
      object (PivotDimensionHeader)
    }
  ],
  "rowCount": integer
}
Fields
pivotDimensionHeaders[]

object (PivotDimensionHeader)

The size is the same as the cardinality of the corresponding dimension combinations.

rowCount

integer

The cardinality of the pivot. The total number of rows for this pivot's fields regardless of how the parameters offset and limit are specified in the request.

PivotDimensionHeader

Summarizes dimension values from a row for this pivot.

JSON representation
{
  "dimensionValues": [
    {
      object (DimensionValue)
    }
  ]
}
Fields
dimensionValues[]

object (DimensionValue)

Values of multiple dimensions in a pivot.