Try the MCP server for Google Analytics. Install from
GitHub, and see the
announcement for more details.
AccessOrderBy
Stay organized with collections
Save and categorize content based on your preferences.
Order bys define how rows will be sorted in the response. For example, ordering rows by descending access count is one ordering, and ordering rows by the country string is a different ordering.
| JSON representation |
{
"desc": boolean,
// Union field one_order_by can be only one of the following:
"metric": {
object (MetricOrderBy)
},
"dimension": {
object (DimensionOrderBy)
}
// End of list of possible types for union field one_order_by.
} |
| Fields |
desc |
boolean
If true, sorts by descending order. If false or unspecified, sorts in ascending order.
|
Union field one_order_by. Specify one type of order by for OrderBy. one_order_by can be only one of the following: |
metric |
object (MetricOrderBy)
Sorts results by a metric's values.
|
dimension |
object (DimensionOrderBy)
Sorts results by a dimension's values.
|
MetricOrderBy
| JSON representation |
{
"metricName": string
} |
| Fields |
metricName |
string
A metric name in the request to order by.
|
DimensionOrderBy
Sorts by dimension values.
| JSON representation |
{
"dimensionName": string,
"orderType": enum (OrderType)
} |
| Fields |
dimensionName |
string
A dimension name in the request to order by.
|
orderType |
enum (OrderType)
Controls the rule for dimension value ordering.
|
OrderType
Rule to order the string dimension values by.
| Enums |
ORDER_TYPE_UNSPECIFIED |
Unspecified. |
ALPHANUMERIC |
Alphanumeric sort by Unicode code point. For example, "2" < "A" < "X" < "b" < "z". |
CASE_INSENSITIVE_ALPHANUMERIC |
Case insensitive alphanumeric sort by lower case Unicode code point. For example, "2" < "A" < "b" < "X" < "z". |
NUMERIC |
Dimension values are converted to numbers before sorting. For example in NUMERIC sort, "25" < "100", and in ALPHANUMERIC sort, "100" < "25". Non-numeric dimension values all have equal ordering value below all numeric values. |
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-04-02 UTC.
[null,null,["Last updated 2025-04-02 UTC."],[[["\u003cp\u003eOrderBys determine the sorting of rows in responses, such as by access count or country.\u003c/p\u003e\n"],["\u003cp\u003eYou can order by metrics (like values) or dimensions (like country or date).\u003c/p\u003e\n"],["\u003cp\u003eOrdering can be ascending (default) or descending, controlled by the \u003ccode\u003edesc\u003c/code\u003e boolean.\u003c/p\u003e\n"],["\u003cp\u003eDimension ordering further offers alphanumeric, case-insensitive alphanumeric, and numeric options for string values.\u003c/p\u003e\n"]]],["The content defines how to sort rows in a response using \"OrderBys.\" Sorting can be ascending or descending via a boolean `desc`. Rows are sorted by either `metric` values, specified by `metricName`, or by `dimension` values, specified by `dimensionName`. For dimensions, `orderType` controls the sorting rule. `orderType` supports `ALPHANUMERIC`, `CASE_INSENSITIVE_ALPHANUMERIC`, or `NUMERIC`. The `MetricOrderBy` and `DimensionOrderBy` structures are used to define the criteria of sorting.\n"],null,["# AccessOrderBy\n\n- [JSON representation](#SCHEMA_REPRESENTATION)\n- [MetricOrderBy](#MetricOrderBy)\n - [JSON representation](#MetricOrderBy.SCHEMA_REPRESENTATION)\n- [DimensionOrderBy](#DimensionOrderBy)\n - [JSON representation](#DimensionOrderBy.SCHEMA_REPRESENTATION)\n- [OrderType](#OrderType)\n\nOrder bys define how rows will be sorted in the response. For example, ordering rows by descending access count is one ordering, and ordering rows by the country string is a different ordering.\n\n| JSON representation |\n|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"desc\": boolean, // Union field `one_order_by` can be only one of the following: \"metric\": { object (/analytics/devguides/config/admin/v1/rest/v1alpha/AccessOrderBy#MetricOrderBy) }, \"dimension\": { object (/analytics/devguides/config/admin/v1/rest/v1alpha/AccessOrderBy#DimensionOrderBy) } // End of list of possible types for union field `one_order_by`. } ``` |\n\n| Fields ||\n|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `desc` | `boolean` If true, sorts by descending order. If false or unspecified, sorts in ascending order. |\n| Union field `one_order_by`. Specify one type of order by for `OrderBy`. `one_order_by` can be only one of the following: ||\n| `metric` | `object (`[MetricOrderBy](/analytics/devguides/config/admin/v1/rest/v1alpha/AccessOrderBy#MetricOrderBy)`)` Sorts results by a metric's values. |\n| `dimension` | `object (`[DimensionOrderBy](/analytics/devguides/config/admin/v1/rest/v1alpha/AccessOrderBy#DimensionOrderBy)`)` Sorts results by a dimension's values. |\n\nMetricOrderBy\n-------------\n\nSorts by metric values.\n\n| JSON representation |\n|----------------------------------|\n| ``` { \"metricName\": string } ``` |\n\n| Fields ||\n|--------------|----------------------------------------------------|\n| `metricName` | `string` A metric name in the request to order by. |\n\nDimensionOrderBy\n----------------\n\nSorts by dimension values.\n\n| JSON representation |\n|------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"dimensionName\": string, \"orderType\": enum (/analytics/devguides/config/admin/v1/rest/v1alpha/AccessOrderBy#OrderType) } ``` |\n\n| Fields ||\n|-----------------|---------------------------------------------------------------------------------------------------------------------------------------------------|\n| `dimensionName` | `string` A dimension name in the request to order by. |\n| `orderType` | `enum (`[OrderType](/analytics/devguides/config/admin/v1/rest/v1alpha/AccessOrderBy#OrderType)`)` Controls the rule for dimension value ordering. |\n\nOrderType\n---------\n\nRule to order the string dimension values by.\n\n| Enums ||\n|---------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `ORDER_TYPE_UNSPECIFIED` | Unspecified. |\n| `ALPHANUMERIC` | Alphanumeric sort by Unicode code point. For example, \"2\" \\\u003c \"A\" \\\u003c \"X\" \\\u003c \"b\" \\\u003c \"z\". |\n| `CASE_INSENSITIVE_ALPHANUMERIC` | Case insensitive alphanumeric sort by lower case Unicode code point. For example, \"2\" \\\u003c \"A\" \\\u003c \"b\" \\\u003c \"X\" \\\u003c \"z\". |\n| `NUMERIC` | Dimension values are converted to numbers before sorting. For example in NUMERIC sort, \"25\" \\\u003c \"100\", and in `ALPHANUMERIC` sort, \"100\" \\\u003c \"25\". Non-numeric dimension values all have equal ordering value below all numeric values. |"]]
