RunPivotReportResponse

The response pivot report table corresponding to a pivot request.

AnalyticsDataGoogleMetricsReportingWeb AnalyticsMachine LearningAttribution

Properties

Name	Type	Description
aggregates	array	Aggregation of metric values. Can be totals, minimums, or maximums. The returned aggregations are controlled by the metric_aggregations in the pivot. The type of aggregation returned in each row is sh
dimensionHeaders	array	Describes dimension columns. The number of DimensionHeaders and ordering of DimensionHeaders matches the dimensions present in rows.
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.
metadata	object	Metadata for the report.
metricHeaders	array	Describes metric columns. The number of MetricHeaders and ordering of MetricHeaders matches the metrics present in rows.
pivotHeaders	array	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"] }, { "
propertyQuota	object	This Analytics Property's quota state including this request.
rows	array	Rows of dimension value combinations and metric values in the report.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/RunPivotReportResponse",
  "title": "RunPivotReportResponse",
  "description": "The response pivot report table corresponding to a pivot request.",
  "properties": {
    "aggregates": {
      "description": "Aggregation of metric values. Can be totals, minimums, or maximums. The returned aggregations are controlled by the metric_aggregations in the pivot. The type of aggregation returned in each row is shown by the dimension_values which are set to \"RESERVED_\".",
      "items": {
        "$ref": "#/components/schemas/Row"
      },
      "type": "array"
    },
    "dimensionHeaders": {
      "description": "Describes dimension columns. The number of DimensionHeaders and ordering of DimensionHeaders matches the dimensions present in rows.",
      "items": {
        "$ref": "#/components/schemas/DimensionHeader"
      },
      "type": "array"
    },
    "kind": {
      "description": "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.",
      "type": "string"
    },
    "metadata": {
      "$ref": "#/components/schemas/ResponseMetaData",
      "description": "Metadata for the report."
    },
    "metricHeaders": {
      "description": "Describes metric columns. The number of MetricHeaders and ordering of MetricHeaders matches the metrics present in rows.",
      "items": {
        "$ref": "#/components/schemas/MetricHeader"
      },
      "type": "array"
    },
    "pivotHeaders": {
      "description": "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\" }] }] }]",
      "items": {
        "$ref": "#/components/schemas/PivotHeader"
      },
      "type": "array"
    },
    "propertyQuota": {
      "$ref": "#/components/schemas/PropertyQuota",
      "description": "This Analytics Property's quota state including this request."
    },
    "rows": {
      "description": "Rows of dimension value combinations and metric values in the report.",
      "items": {
        "$ref": "#/components/schemas/Row"
      },
      "type": "array"
    }
  },
  "type": "object"
}