Api-roll 37: 2016-06-06

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": "20160512",
+    "revision": "20160601",
     "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"
@@ skipping 250 matching lines @@
                 }
             },
             "type": "object"
         },
         "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. All requests\nshould have the same cohort definitions."
+                    "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.",
                     "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.",
@@ skipping 18 matching lines @@
                     "type": "array"
                 },
                 "pivots": {
                     "description": "The pivot definitions.",
                     "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)",
+                    "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"
                     },
                     "type": "array"
                 },
                 "segments": {
-                    "description": "Segment the data returned for the request. A segment definition helps look\nat a subset of the segment request. A request can contain up to four\nsegments. All requests should have the same segment definitions. Requests\nwith segments must have the `ga:segment` dimension.",
+                    "description": "Segment the data returned for the request. A segment definition helps look\nat a subset of the segment request. A request can contain up to four\nsegments. Every [ReportRequest](#ReportRequest) within a\n`batchGet` method must contain the same `segments` definition. Requests\nwith segments must have the `ga:segment` dimension.",
                     "items": {
                         "$ref": "Segment"
                     },
                     "type": "array"
                 },
                 "samplingLevel": {
-                    "description": "The desired sampling level. If the sampling level is not specified the\nDEFAULT sampling level will be used. All requests should have same\n`samplingLevel`.",
+                    "description": "The desired report\n[sample](https://support.google.com/analytics/answer/2637192) size.\nIf the the `samplingLevel` field is unspecified the `DEFAULT` sampling\nlevel is used. Every [ReportRequest](#ReportRequest) within a\n`batchGet` method must contain the same `samplingLevel` definition. See\n[developer guide](/analytics/devguides/reporting/core/v4/basics#sampling)\n for details.",
                     "enum": [
                         "SAMPLING_UNSPECIFIED",
                         "DEFAULT",
                         "SMALL",
                         "LARGE"
                     ],
                     "enumDescriptions": [
-                        "If sampling level is unspecified the default sampling level is used.",
+                        "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.",
                     "items": {
                         "$ref": "Metric"
@@ skipping 14 matching lines @@
                 },
                 "filtersExpression": {
                     "description": "Dimension or metric filters that restrict the data returned for your\nrequest. To use the `filtersExpression`, supply a dimension or metric on\nwhich to filter, followed by the filter expression. For example, the\nfollowing expression selects `ga:browser` dimension which starts with\nFirefox; `ga:browser=~^Firefox`. For more information on dimensions\nand metric filters, see\n[Filters reference](https://developers.google.com/analytics/devguides/reporting/core/v3/reference#filters).",
                     "type": "string"
                 },
                 "hideValueRanges": {
                     "description": "If set to true, hides the minimum and maximum across all matching rows.\nThe default is false and the value ranges are returned.",
                     "type": "boolean"
                 },
                 "viewId": {
-                    "description": "Unique View Id for retrieving Analytics data.",
+                    "description": "The Analytics\n[view ID](https://support.google.com/analytics/answer/1009618)\nfrom which to retrieve data. Every [ReportRequest](#ReportRequest)\nwithin a `batchGet` method must contain the same `viewId`.",
                     "type": "string"
                 },
                 "pageToken": {
                     "description": "A continuation token to get the next page of the results. Adding this to\nthe request will return the rows after the pageToken. The pageToken should\nbe the value returned in the nextPageToken parameter in the response to\nthe GetReports request.",
                     "type": "string"
                 }
             },
             "type": "object"
         },
         "SimpleSegment": {
@@ skipping 82 matching lines @@
         "ReportData": {
             "description": "The data part of the report.",
             "id": "ReportData",
             "properties": {
                 "rowCount": {
                     "description": "Total number of matching rows for this query.",
                     "format": "int32",
                     "type": "integer"
                 },
                 "samplingSpaceSizes": {
-                    "description": "If sampling was enabled, this returns the total number of samples\npresent, one entry per date range.",
+                    "description": "If the results are\n[sampled](https://support.google.com/analytics/answer/2637192),\nthis returns the total number of\nsamples present, one entry per date range. If the results are not sampled\nthis field will not be defined. See\n[developer guide](/analytics/devguides/reporting/core/v4/basics#sampling)\nfor details.",
                     "items": {
                         "format": "int64",
                         "type": "string"
                     },
                     "type": "array"
                 },
                 "maximums": {
                     "description": "Minimum and maximum values seen over all matching rows. These are both\nempty when `hideValueRanges` in the request is false, or when\nrowCount is zero.",
                     "items": {
                         "$ref": "DateRangeValues"
                     },
                     "type": "array"
                 },
                 "samplesReadCounts": {
-                    "description": "If sampling was enabled, this returns the total number of samples\nread, one entry per date range",
+                    "description": "If the results are\n[sampled](https://support.google.com/analytics/answer/2637192),\nthis returns the total number of samples read, one entry per date range.\nIf the results are not sampled this field will not be defined. See\n[developer guide](/analytics/devguides/reporting/core/v4/basics#sampling)\nfor details.",
                     "items": {
                         "format": "int64",
                         "type": "string"
                     },
                     "type": "array"
                 },
                 "minimums": {
                     "description": "Minimum and maximum values seen over all matching rows. These are both\nempty when `hideValueRanges` in the request is false, or when\nrowCount is zero.",
                     "items": {
                         "$ref": "DateRangeValues"
@@ skipping 19 matching lines @@
                     "type": "boolean"
                 }
             },
             "type": "object"
         },
         "GetReportsRequest": {
             "description": "The batch request containing multiple report request.",
             "id": "GetReportsRequest",
             "properties": {
                 "reportRequests": {
-                    "description": "Requests, each request will have a separate response.\nThere can be a maximum of 5 requests. All requests should have the same\n`dateRange`, `viewId`, `segments`, `samplingLevel`, and `cohortGroup`.",
+                    "description": "Requests, each request will have a separate response.\nThere can be a maximum of 5 requests. All requests should have the same\n`dateRanges`, `viewId`, `segments`, `samplingLevel`, and `cohortGroup`.",
                     "items": {
                         "$ref": "ReportRequest"
                     },
                     "type": "array"
                 }
             },
             "type": "object"
         },
         "OrderBy": {
             "description": "Specifies the sorting options.",
@@ skipping 18 matching lines @@
                     "enum": [
                         "ORDER_TYPE_UNSPECIFIED",
                         "VALUE",
                         "DELTA",
                         "SMART",
                         "HISTOGRAM_BUCKET",
                         "DIMENSION_AS_INTEGER"
                     ],
                     "enumDescriptions": [
                         "Unspecified order type will be treated as sort based on value.",
-                        "The sort order is based on the value of the chosen column; looks only at\nthe first date range",
+                        "The sort order is based on the value of the chosen column; looks only at\nthe first date range.",
                         "The sort order is based on the difference of the values of the chosen\ncolumn between the first two date ranges.  Usable only if there are\nexactly two date ranges.",
                         "The sort order is based on weighted value of the chosen column.  If\ncolumn has n/d format, then weighted value of this ratio will\nbe `(n + totals.n)/(d + totals.d)` Usable only for metrics that\nrepresent ratios.",
                         "Histogram order type is applicable only to dimension columns with\nnon-empty histogram-buckets.",
                         "If the dimensions are fixed length numbers, ordinary sort would just\nwork fine. `DIMENSION_AS_INTEGER` can be used if the dimensions are\nvariable length numbers."
                     ],
                     "type": "string"
                 },
                 "fieldName": {
                     "description": "The field which to sort by. The default sort order is ascending. Example:\n`ga:browser`.\nNote, that you can only specify one field for sort here. For example,\n`ga:browser, ga:city` is not valid.",
                     "type": "string"
@@ skipping 77 matching lines @@
                     "description": "A Simple segment conditions consist of one or more dimension/metric\nconditions that can be combined"
                 }
             },
             "type": "object"
         },
         "PivotHeaderEntry": {
             "description": "The headers for the each of the metric column corresponding to the metrics\nrequested in the pivots section of the response.",
             "id": "PivotHeaderEntry",
             "properties": {
                 "dimensionNames": {
-                    "description": "The name of the dimensions in the pivotDimensionValues field in the\nresponse.",
+                    "description": "The name of the dimensions in the pivot response.",
                     "items": {
                         "type": "string"
                     },
                     "type": "array"
                 },
                 "dimensionValues": {
                     "description": "The values for the dimensions in the pivot.",
                     "items": {
                         "type": "string"
                     },
@@ skipping 184 matching lines @@
             "id": "ReportRow",
             "properties": {
                 "dimensions": {
                     "description": "List of requested dimensions.",
                     "items": {
                         "type": "string"
                     },
                     "type": "array"
                 },
                 "metrics": {
-                    "description": "List of metrics for each requested DateRange",
+                    "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",
@@ skipping 126 matching lines @@
                     "type": "array"
                 }
             },
             "type": "object"
         }
     },
     "servicePath": "",
     "title": "Google Analytics Reporting API",
     "version": "v4"
 }