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 followingpivotHeadersin the response: "pivotHeaders" : [{ "dimensionHeaders": [{ "dimensionValues": [ { "value": "United Kingdom" }, { "value": "London" } ] }, { "dimensionValues": [ { "value": "Japan" }, { "value": "Osaka" } ] }] }, { "dimensionHeaders": [{ "dimensionValues": [{ "value": "session_start" }] }, { "dimensionValues": [{ "value": "scroll" }] }] }]
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_
This Google Analytics property's quota state including this request.
↳ kind
string
Identifies what kind of resource this message is. Thiskindis always the fixed string "analyticsData#runPivotReport". Useful to distinguish between response types in JSON.
getPivotHeaders
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 followingpivotHeadersin the response:
"pivotHeaders" : [{
"dimensionHeaders": [{
"dimensionValues": [
{ "value": "United Kingdom" },
{ "value": "London" }
]
},
{
"dimensionValues": [
{ "value": "Japan" },
{ "value": "Osaka" }
]
}]
},
{
"dimensionHeaders": [{
"dimensionValues": [{ "value": "session_start" }]
},
{
"dimensionValues": [{ "value": "scroll" }]
}]
}]
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 followingpivotHeadersin the response:
"pivotHeaders" : [{
"dimensionHeaders": [{
"dimensionValues": [
{ "value": "United Kingdom" },
{ "value": "London" }
]
},
{
"dimensionValues": [
{ "value": "Japan" },
{ "value": "Osaka" }
]
}]
},
{
"dimensionHeaders": [{
"dimensionValues": [{ "value": "session_start" }]
},
{
"dimensionValues": [{ "value": "scroll" }]
}]
}]
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_
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_
Identifies what kind of resource this message is. Thiskindis always the
fixed string "analyticsData#runPivotReport". Useful to distinguish between
response types in JSON.
Returns
Type
Description
string
setKind
Identifies what kind of resource this message is. Thiskindis always the
fixed string "analyticsData#runPivotReport". Useful to distinguish between
response types in JSON.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Google Analytics Data V1beta Client - Class RunPivotReportResponse (0.22.3)\n\nVersion latestkeyboard_arrow_down\n\n- [0.22.3 (latest)](/php/docs/reference/analytics-data/latest/V1beta.RunPivotReportResponse)\n- [0.22.2](/php/docs/reference/analytics-data/0.22.2/V1beta.RunPivotReportResponse)\n- [0.21.1](/php/docs/reference/analytics-data/0.21.1/V1beta.RunPivotReportResponse)\n- [0.20.1](/php/docs/reference/analytics-data/0.20.1/V1beta.RunPivotReportResponse)\n- [0.19.0](/php/docs/reference/analytics-data/0.19.0/V1beta.RunPivotReportResponse)\n- [0.18.0](/php/docs/reference/analytics-data/0.18.0/V1beta.RunPivotReportResponse)\n- [0.17.1](/php/docs/reference/analytics-data/0.17.1/V1beta.RunPivotReportResponse)\n- [0.16.4](/php/docs/reference/analytics-data/0.16.4/V1beta.RunPivotReportResponse)\n- [0.14.0](/php/docs/reference/analytics-data/0.14.0/V1beta.RunPivotReportResponse)\n- [0.13.0](/php/docs/reference/analytics-data/0.13.0/V1beta.RunPivotReportResponse)\n- [0.12.0](/php/docs/reference/analytics-data/0.12.0/V1beta.RunPivotReportResponse)\n- [0.11.2](/php/docs/reference/analytics-data/0.11.2/V1beta.RunPivotReportResponse)\n- [0.10.1](/php/docs/reference/analytics-data/0.10.1/V1beta.RunPivotReportResponse)\n- [0.9.5](/php/docs/reference/analytics-data/0.9.5/V1beta.RunPivotReportResponse) \n| **Beta**\n|\n|\n| This library is covered by the [Pre-GA Offerings Terms](/terms/service-terms#1)\n| of the Terms of Service. Pre-GA libraries might have limited support,\n| and changes to pre-GA libraries might not be compatible with other pre-GA versions.\n| For more information, see the\n[launch stage descriptions](/products#product-launch-stages). \nReference documentation and code samples for the Google Analytics Data V1beta Client class RunPivotReportResponse.\n\nThe response pivot report table corresponding to a pivot request.\n\nGenerated from protobuf message `google.analytics.data.v1beta.RunPivotReportResponse`\n\nNamespace\n---------\n\nGoogle \\\\ Analytics \\\\ Data \\\\ V1beta\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getPivotHeaders\n\nSummarizes the columns and rows created by a pivot. Each pivot in the\nrequest produces one header in the response. If we have a request like\nthis:\n\"pivots\": \\[{\n\"fieldNames\": \\[\"country\",\n\"city\"\\]\n},\n{\n\"fieldNames\": \"eventName\"\n}\\]\nWe will have the following `pivotHeaders` in the response:\n\"pivotHeaders\" : \\[{\n\"dimensionHeaders\": \\[{\n\"dimensionValues\": \\[\n{ \"value\": \"United Kingdom\" },\n{ \"value\": \"London\" }\n\\]\n},\n{\n\"dimensionValues\": \\[\n{ \"value\": \"Japan\" },\n{ \"value\": \"Osaka\" }\n\\]\n}\\]\n},\n{\n\"dimensionHeaders\": \\[{\n\"dimensionValues\": \\[{ \"value\": \"session_start\" }\\]\n},\n{\n\"dimensionValues\": \\[{ \"value\": \"scroll\" }\\]\n}\\]\n}\\]\n\n### setPivotHeaders\n\nSummarizes the columns and rows created by a pivot. Each pivot in the\nrequest produces one header in the response. If we have a request like\nthis:\n\"pivots\": \\[{\n\"fieldNames\": \\[\"country\",\n\"city\"\\]\n},\n{\n\"fieldNames\": \"eventName\"\n}\\]\nWe will have the following `pivotHeaders` in the response:\n\"pivotHeaders\" : \\[{\n\"dimensionHeaders\": \\[{\n\"dimensionValues\": \\[\n{ \"value\": \"United Kingdom\" },\n{ \"value\": \"London\" }\n\\]\n},\n{\n\"dimensionValues\": \\[\n{ \"value\": \"Japan\" },\n{ \"value\": \"Osaka\" }\n\\]\n}\\]\n},\n{\n\"dimensionHeaders\": \\[{\n\"dimensionValues\": \\[{ \"value\": \"session_start\" }\\]\n},\n{\n\"dimensionValues\": \\[{ \"value\": \"scroll\" }\\]\n}\\]\n}\\]\n\n### getDimensionHeaders\n\nDescribes dimension columns. The number of DimensionHeaders and ordering of\nDimensionHeaders matches the dimensions present in rows.\n\n### setDimensionHeaders\n\nDescribes dimension columns. The number of DimensionHeaders and ordering of\nDimensionHeaders matches the dimensions present in rows.\n\n### getMetricHeaders\n\nDescribes metric columns. The number of MetricHeaders and ordering of\nMetricHeaders matches the metrics present in rows.\n\n### setMetricHeaders\n\nDescribes metric columns. The number of MetricHeaders and ordering of\nMetricHeaders matches the metrics present in rows.\n\n### getRows\n\nRows of dimension value combinations and metric values in the report.\n\n### setRows\n\nRows of dimension value combinations and metric values in the report.\n\n### getAggregates\n\nAggregation of metric values. Can be totals, minimums, or maximums. The\nreturned aggregations are controlled by the metric_aggregations in the\npivot. The type of aggregation returned in each row is shown by the\ndimension_values which are set to \"RESERVED_\n\n\n### setAggregates\n\nAggregation of metric values. Can be totals, minimums, or maximums. The\nreturned aggregations are controlled by the metric_aggregations in the\npivot. The type of aggregation returned in each row is shown by the\ndimension_values which are set to \"RESERVED_\n\n\n### getMetadata\n\nMetadata for the report.\n\n### hasMetadata\n\n### clearMetadata\n\n### setMetadata\n\nMetadata for the report.\n\n### getPropertyQuota\n\nThis Google Analytics property's quota state including this request.\n\n### hasPropertyQuota\n\n### clearPropertyQuota\n\n### setPropertyQuota\n\nThis Google Analytics property's quota state including this request.\n\n### getKind\n\nIdentifies what kind of resource this message is. This `kind` is always the\nfixed string \"analyticsData#runPivotReport\". Useful to distinguish between\nresponse types in JSON.\n\n### setKind\n\nIdentifies what kind of resource this message is. This `kind` is always the\nfixed string \"analyticsData#runPivotReport\". Useful to distinguish between\nresponse types in JSON."]]
