Dimension names for visible columns in the report response. Including "dateRange" produces a date range column; for each row in the response, dimension values in the date range column will indicate the corresponding date range from the request.
Specifies how dimensions are ordered in the pivot. In the first Pivot, the OrderBys determine Row and PivotDimensionHeader ordering; in subsequent Pivots, the OrderBys determine only PivotDimensionHeader ordering. Dimensions specified in these OrderBys must be a subset of Pivot.field_names.
The number of unique combinations of dimension values to return in this pivot. Thelimitparameter is required. Alimitof 10,000 is common for single pivot requests.
The product of thelimitfor eachpivotin aRunPivotReportRequestmust not exceed 250,000. For example, a two pivot request withlimit:
1000in each pivot will fail because the product is1,000,000.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-11-19 UTC."],[[["\u003cp\u003eJSON representation describes the structure for defining the layout and data of a report, including visible dimensions and rows.\u003c/p\u003e\n"],["\u003cp\u003eIt allows specifying dimension names, ordering, data range, row limits, and metric aggregations for the report output.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eorderBys\u003c/code\u003e field determines the ordering of dimensions within the report, impacting both row and pivot dimension headers.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eoffset\u003c/code\u003e and \u003ccode\u003elimit\u003c/code\u003e fields control the range of rows returned, with \u003ccode\u003elimit\u003c/code\u003e being a required parameter subject to specific constraints.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003emetricAggregations\u003c/code\u003e enables the aggregation of metrics based on dimensions, providing summarized insights within the report.\u003c/p\u003e\n"]]],["The core content defines the structure for visible report dimensions. `fieldNames` specifies dimension names, including \"dateRange\" for date-specific columns. `orderBys` dictates dimension ordering within pivots. `offset` and `limit` control row selection, with `limit` denoting the number of unique dimension combinations. `metricAggregations` allows for metric aggregation by dimensions. The combined `limit` of all pivots in a request must not exceed 250,000.\n"],null,["# Pivot\n\n- [JSON representation](#SCHEMA_REPRESENTATION)\n\nDescribes the visible dimension columns and rows in the report response.\n\n| JSON representation |\n|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"fieldNames\": [ string ], \"orderBys\": [ { object (/analytics/devguides/reporting/data/v1/rest/v1beta/OrderBy) } ], \"offset\": string, \"limit\": string, \"metricAggregations\": [ enum (/analytics/devguides/reporting/data/v1/rest/v1beta/MetricAggregation) ] } ``` |\n\n| Fields ||\n|--------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `field``Names[]` | `string` Dimension names for visible columns in the report response. Including \"dateRange\" produces a date range column; for each row in the response, dimension values in the date range column will indicate the corresponding date range from the request. |\n| `order``Bys[]` | `object (`[OrderBy](/analytics/devguides/reporting/data/v1/rest/v1beta/OrderBy)`)` Specifies how dimensions are ordered in the pivot. In the first Pivot, the OrderBys determine Row and PivotDimensionHeader ordering; in subsequent Pivots, the OrderBys determine only PivotDimensionHeader ordering. Dimensions specified in these OrderBys must be a subset of Pivot.field_names. |\n| `offset` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` The row count of the start row. The first row is counted as row 0. |\n| `limit` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` The number of unique combinations of dimension values to return in this pivot. The `limit` parameter is required. A `limit` of 10,000 is common for single pivot requests. The product of the `limit` for each `pivot` in a `RunPivotReportRequest` must not exceed 250,000. For example, a two pivot request with `limit: 1000` in each pivot will fail because the product is `1,000,000`. |\n| `metric``Aggregations[]` | `enum (`[MetricAggregation](/analytics/devguides/reporting/data/v1/rest/v1beta/MetricAggregation)`)` Aggregate the metrics by dimensions in this pivot using the specified metricAggregations. |"]]
