Api-roll 39: 2016-07-18

discovery/googleapis/analyticsreporting__v4.json

 {
     "auth": {
         "oauth2": {
             "scopes": {
                 "https://www.googleapis.com/auth/analytics.readonly": {
                     "description": "View your Google Analytics data"
                 },
                 "https://www.googleapis.com/auth/analytics": {
                     "description": "View and manage your Google Analytics data"
                 }
@@ skipping 122 matching lines @@
                         "$ref": "GetReportsResponse"
                     },
                     "scopes": [
                         "https://www.googleapis.com/auth/analytics",
                         "https://www.googleapis.com/auth/analytics.readonly"
                     ]
                 }
             }
         }
     },
-    "revision": "20160616",
+    "revision": "20160714",
     "rootUrl": "https://analyticsreporting.googleapis.com/",
     "schemas": {
         "PivotHeader": {
             "description": "The headers for each of the pivot sections defined in the request.",
             "id": "PivotHeader",
             "properties": {
                 "totalPivotGroupsCount": {
                     "description": "The total number of groups for this pivot.",
                     "format": "int32",
                     "type": "integer"
                 },
                 "pivotHeaderEntries": {
                     "description": "A single pivot section header.",
                     "items": {
                         "$ref": "PivotHeaderEntry"
                     },
                     "type": "array"
                 }
             },
             "type": "object"
         },
         "Metric": {
-            "description": "A metric in the request.",
+            "description": "[Metrics](https://support.google.com/analytics/answer/1033861)\nare the quantitative measurements. For example, the metric `ga:users`\nindicates the total number of users for the requested time period.",
             "id": "Metric",
             "properties": {
                 "alias": {
                     "description": "An alias for the metric expression is an alternate name for the\nexpression. The alias can be used for filtering and sorting. This field\nis optional and is useful if the expression is not a single metric but\na complex expression which cannot be used in filtering and sorting.\nThe alias is also used in the response column header.",
                     "type": "string"
                 },
                 "formattingType": {
                     "description": "Specifies how the metric expression should be formatted, for example\n`INTEGER`.",
                     "enum": [
                         "METRIC_TYPE_UNSPECIFIED",
@@ skipping 230 matching lines @@
         },
         "ReportRequest": {
             "description": "The main request class which specifies the Reporting API request.",
             "id": "ReportRequest",
             "properties": {
                 "cohortGroup": {
                     "$ref": "CohortGroup",
                     "description": "Cohort group associated with this request. If there is a cohort group\nin the request the `ga:cohort` dimension must be present.\nEvery [ReportRequest](#ReportRequest) within a `batchGet` method must\ncontain the same `cohortGroup` definition."
                 },
                 "dimensions": {
-                    "description": "Dimensions requested in the request.",
+                    "description": "The dimensions requested.\nRequests can have a total of 7 dimensions.",
                     "items": {
                         "$ref": "Dimension"
                     },
                     "type": "array"
                 },
                 "metricFilterClauses": {
                     "description": "The metric filter clauses. They are logically combined with the `AND`\noperator.  Metric filters look at only the first date range and not the\ncomparing date range. Note that filtering on metrics occurs after the\nmetrics are aggregated.",
                     "items": {
                         "$ref": "MetricFilterClause"
                     },
                     "type": "array"
                 },
                 "hideTotals": {
                     "description": "If set to true, hides the total of all metrics for all the matching rows,\nfor every date range. The default false and will return the totals.",
                     "type": "boolean"
                 },
                 "includeEmptyRows": {
                     "description": "If set to false, the response does not include rows if all the retrieved\nmetrics are equal to zero. The default is false which will exclude these\nrows.",
                     "type": "boolean"
                 },
                 "dimensionFilterClauses": {
                     "description": "The dimension filter clauses for filtering Dimension Values. They are\nlogically combined with the `AND` operator. Note that filtering occurs\nbefore any dimensions are aggregated, so that the returned metrics\nrepresent the total for only the relevant dimensions.",
                     "items": {
                         "$ref": "DimensionFilterClause"
                     },
                     "type": "array"
                 },
                 "pivots": {
-                    "description": "The pivot definitions.",
+                    "description": "The pivot definitions. Requests can have a maximum of 2 pivots.",
                     "items": {
                         "$ref": "Pivot"
                     },
                     "type": "array"
                 },
                 "dateRanges": {
                     "description": "Date ranges in the request. The request can have a maximum of 2 date\nranges. The response will contain a set of metric values for each\ncombination of the dimensions for each date range in the request. So, if\nthere are two date ranges, there will be two set of metric values, one for\nthe original date range and one for the second date range.\nThe `reportRequest.dateRanges` field should not be specified for cohorts\nor Lifetime value requests.\nIf a date range is not provided, the default date range is (startDate:\ncurrent date - 7 days, endDate: current date - 1 day). Every\n[ReportRequest](#ReportRequest) within a `batchGet` method must\ncontain the same `dateRanges` definition.",
                     "items": {
                         "$ref": "DateRange"
                     },
@@ skipping 16 matching lines @@
                     ],
                     "enumDescriptions": [
                         "If the `samplingLevel` field is unspecified the `DEFAULT` sampling level\nis used.",
                         "Returns response with a sample size that balances speed and\naccuracy.",
                         "It returns a fast response with a smaller sampling size.",
                         "Returns a more accurate response using a large sampling size. But this\nmay result in response being slower."
                     ],
                     "type": "string"
                 },
                 "metrics": {
-                    "description": "Metrics, the quantitative measurements, requested in the request.\nRequests must specify at least one metric.",
+                    "description": "The metrics requested.\nRequests must specify at least one metric. Requests can have a\ntotal of 10 metrics.",
                     "items": {
                         "$ref": "Metric"
                     },
                     "type": "array"
                 },
                 "pageSize": {
                     "description": "Page size is for paging and specifies the maximum number of returned rows.\nPage size should be >= 0. A query returns the default of 1,000 rows.\nThe Analytics Core Reporting API returns a maximum of 10,000 rows per\nrequest, no matter how many you ask for. It can also return fewer rows\nthan requested, if there aren't as many dimension segments as you expect.\nFor instance, there are fewer than 300 possible values for `ga:country`,\nso when segmenting only by country, you can't get more than 300 rows,\neven if you set `pageSize` to a higher value.",
                     "format": "int32",
                     "type": "integer"
                 },
@@ skipping 382 matching lines @@
                     "type": "array"
                 }
             },
             "type": "object"
         },
         "Pivot": {
             "description": "The Pivot describes the pivot section in the request.\nThe Pivot helps rearrange the information in the table for certain reports\nby pivoting your data on a second dimension.",
             "id": "Pivot",
             "properties": {
                 "dimensions": {
-                    "description": "A list of dimensions to show as pivot columns.",
+                    "description": "A list of dimensions to show as pivot columns. A Pivot can have a maximum\nof 4 dimensions.",
                     "items": {
                         "$ref": "Dimension"
                     },
                     "type": "array"
                 },
                 "metrics": {
-                    "description": "Metrics to aggregate and return.",
+                    "description": "The pivot metrics. Pivot metrics are part of the\nrestriction on total number of metrics in the request.",
                     "items": {
                         "$ref": "Metric"
                     },
                     "type": "array"
                 },
                 "maxGroupCount": {
                     "description": "Specifies the maximum number of groups to return.\nThe default value is 10, also the maximum value is 1,000.",
                     "format": "int32",
                     "type": "integer"
                 },
@@ skipping 106 matching lines @@
                     "description": "List of metrics for each requested DateRange.",
                     "items": {
                         "$ref": "DateRangeValues"
                     },
                     "type": "array"
                 }
             },
             "type": "object"
         },
         "CohortGroup": {
-            "description": "Defines a cohort group.\nFor example:\n\n    \"cohortGroup\": {\n      \"cohorts\": [{\n        \"name\": \"cohort 1\",\n        \"type\": \"FIRST_VISIT_DATE\",\n        \"dateRange\": { \"startDate\": \"2015-08-01\", \"endDate\": \"2015-08-01\" }\n      },{\n        \"name\": \"cohort 2\"\n         \"type\": \"FIRST_VISIT_DATE\"\n         \"dateRange\": { \"startDate\": \"2015-07-01\", \"endDate\": \"2015-07-01\" }\n      }]\n    }\n",
+            "description": "Defines a cohort group.\nFor example:\n\n    \"cohortGroup\": {\n      \"cohorts\": [{\n        \"name\": \"cohort 1\",\n        \"type\": \"FIRST_VISIT_DATE\",\n        \"dateRange\": { \"startDate\": \"2015-08-01\", \"endDate\": \"2015-08-01\" }\n      },{\n        \"name\": \"cohort 2\"\n         \"type\": \"FIRST_VISIT_DATE\"\n         \"dateRange\": { \"startDate\": \"2015-07-01\", \"endDate\": \"2015-07-01\" }\n      }]\n    }",
             "id": "CohortGroup",
             "properties": {
                 "lifetimeValue": {
                     "description": "Enable Life Time Value (LTV).  LTV measures lifetime value for users\nacquired through different channels.\nPlease see:\n[Cohort Analysis](https://support.google.com/analytics/answer/6074676) and\n[Lifetime Value](https://support.google.com/analytics/answer/6182550)\nIf the value of lifetimeValue is false:\n\n- The metric values are similar to the values in the web interface cohort\n  report.\n- The cohort definition date ranges must be aligned to the calendar week\n  and month. i.e. while requesting `ga:cohortNthWeek` the `startDate` in\n  the cohort definition should be a Sunday and the `endDate` should be the\n  following Saturday, and for `ga:cohortNthMonth`, the `startDate`\n  should be the 1st of the month and `endDate` should be the last day\n  of the month.\n\nWhen the lifetimeValue is true:\n\n- The metric values will correspond to the values in the web interface\n  LifeTime value report.\n- The Lifetime Value report shows you how user value (Revenue) and\n  engagement (Appviews, Goal Completions, Sessions, and Session Duration)\n  grow during the 90 days after a user is acquired.\n- The metrics are calculated as a cumulative average per user per the time\n  increment.\n- The cohort definition date ranges need not be aligned to the calendar\n  week and month boundaries.\n- The `viewId` must be an\n  [app view ID](https://support.google.com/analytics/answer/2649553#WebVersusAppViews)",
                     "type": "boolean"
                 },
                 "cohorts": {
                     "description": "The definition for the cohort.",
                     "items": {
                         "$ref": "Cohort"
@@ skipping 79 matching lines @@
                     "type": "string"
                 },
                 "not": {
                     "description": "Logical `NOT` operator. If this boolean is set to true, then the matching\nmetric values will be excluded in the report. The default is false.",
                     "type": "boolean"
                 }
             },
             "type": "object"
         },
         "Dimension": {
-            "description": "A dimension in the request.",
+            "description": "[Dimensions](https://support.google.com/analytics/answer/1033861)\nare attributes of your data. For example, the dimension `ga:city`\nindicates the city, for example, \"Paris\" or \"New York\", from which\na session originates.",
             "id": "Dimension",
             "properties": {
                 "histogramBuckets": {
                     "description": "If non-empty, we place dimension values into buckets after string to\nint64. Dimension values that are not the string representation of an\nintegral value will be converted to zero.  The bucket values have to be in\nincreasing order.  Each bucket is closed on the lower end, and open on the\nupper end. The \"first\" bucket includes all values less than the first\nboundary, the \"last\" bucket includes all values up to infinity. Dimension\nvalues that fall in a bucket get transformed to a new dimension value. For\nexample, if one gives a list of \"0, 1, 3, 4, 7\", then we return the\nfollowing buckets:\n\n- bucket #1: values < 0, dimension value \"<0\"\n- bucket #2: values in [0,1), dimension value \"0\"\n- bucket #3: values in [1,3), dimension value \"1-2\"\n- bucket #4: values in [3,4), dimension value \"3\"\n- bucket #5: values in [4,7), dimension value \"4-6\"\n- bucket #6: values >= 7, dimension value \"7+\"\n\nNOTE: If you are applying histogram mutation on any dimension, and using\nthat dimension in sort, you will want to use the sort type\n`HISTOGRAM_BUCKET` for that purpose. Without that the dimension values\nwill be sorted according to dictionary\n(lexicographic) order. For example the ascending dictionary order is:\n\n   \"<50\", \"1001+\", \"121-1000\", \"50-120\"\n\nAnd the ascending `HISTOGRAM_BUCKET` order is:\n\n   \"<50\", \"50-120\", \"121-1000\", \"1001+\"\n\nThe client has to explicitly request `\"orderType\": \"HISTOGRAM_BUCKET\"`\nfor a histogram-mutated dimension.",
                     "items": {
                         "format": "int64",
                         "type": "string"
                     },
                     "type": "array"
                 },
@@ skipping 16 matching lines @@
                     "type": "array"
                 }
             },
             "type": "object"
         }
     },
     "servicePath": "",
     "title": "Google Analytics Reporting API",
     "version": "v4"
 }