forked from googleapis/google-api-go-client
-
Notifications
You must be signed in to change notification settings - Fork 0
/
analyticsreporting-api.json
1683 lines (1683 loc) · 74 KB
/
analyticsreporting-api.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
{
"auth": {
"oauth2": {
"scopes": {
"https://www.googleapis.com/auth/analytics": {
"description": "View and manage your Google Analytics data"
},
"https://www.googleapis.com/auth/analytics.readonly": {
"description": "See and download your Google Analytics data"
}
}
}
},
"basePath": "",
"baseUrl": "https://analyticsreporting.googleapis.com/",
"batchPath": "batch",
"canonicalName": "AnalyticsReporting",
"description": "Accesses Analytics report data.",
"discoveryVersion": "v1",
"documentationLink": "https://developers.google.com/analytics/devguides/reporting/core/v4/",
"fullyEncodeReservedExpansion": true,
"icons": {
"x16": "http://www.google.com/images/icons/product/search-16.gif",
"x32": "http://www.google.com/images/icons/product/search-32.gif"
},
"id": "analyticsreporting:v4",
"kind": "discovery#restDescription",
"mtlsRootUrl": "https://analyticsreporting.mtls.googleapis.com/",
"name": "analyticsreporting",
"ownerDomain": "google.com",
"ownerName": "Google",
"parameters": {
"$.xgafv": {
"description": "V1 error format.",
"enum": [
"1",
"2"
],
"enumDescriptions": [
"v1 error format",
"v2 error format"
],
"location": "query",
"type": "string"
},
"access_token": {
"description": "OAuth access token.",
"location": "query",
"type": "string"
},
"alt": {
"default": "json",
"description": "Data format for response.",
"enum": [
"json",
"media",
"proto"
],
"enumDescriptions": [
"Responses with Content-Type of application/json",
"Media download with context-dependent Content-Type",
"Responses with Content-Type of application/x-protobuf"
],
"location": "query",
"type": "string"
},
"callback": {
"description": "JSONP",
"location": "query",
"type": "string"
},
"fields": {
"description": "Selector specifying which fields to include in a partial response.",
"location": "query",
"type": "string"
},
"key": {
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
"location": "query",
"type": "string"
},
"oauth_token": {
"description": "OAuth 2.0 token for the current user.",
"location": "query",
"type": "string"
},
"prettyPrint": {
"default": "true",
"description": "Returns response with indentations and line breaks.",
"location": "query",
"type": "boolean"
},
"quotaUser": {
"description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
"location": "query",
"type": "string"
},
"uploadType": {
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"location": "query",
"type": "string"
},
"upload_protocol": {
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
"location": "query",
"type": "string"
}
},
"protocol": "rest",
"resources": {
"reports": {
"methods": {
"batchGet": {
"description": "Returns the Analytics data.",
"flatPath": "v4/reports:batchGet",
"httpMethod": "POST",
"id": "analyticsreporting.reports.batchGet",
"parameterOrder": [],
"parameters": {},
"path": "v4/reports:batchGet",
"request": {
"$ref": "GetReportsRequest"
},
"response": {
"$ref": "GetReportsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/analytics",
"https://www.googleapis.com/auth/analytics.readonly"
]
}
}
},
"userActivity": {
"methods": {
"search": {
"description": "Returns User Activity data.",
"flatPath": "v4/userActivity:search",
"httpMethod": "POST",
"id": "analyticsreporting.userActivity.search",
"parameterOrder": [],
"parameters": {},
"path": "v4/userActivity:search",
"request": {
"$ref": "SearchUserActivityRequest"
},
"response": {
"$ref": "SearchUserActivityResponse"
},
"scopes": [
"https://www.googleapis.com/auth/analytics",
"https://www.googleapis.com/auth/analytics.readonly"
]
}
}
}
},
"revision": "20211020",
"rootUrl": "https://analyticsreporting.googleapis.com/",
"schemas": {
"Activity": {
"description": "An Activity represents data for an activity of a user. Note that an Activity is different from a hit. A hit might result in multiple Activity's. For example, if a hit includes a transaction and a goal completion, there will be two Activity protos for this hit, one for ECOMMERCE and one for GOAL. Conversely, multiple hits can also construct one Activity. In classic e-commerce, data for one transaction might be sent through multiple hits. These hits will be merged into one ECOMMERCE Activity.",
"id": "Activity",
"properties": {
"activityTime": {
"description": "Timestamp of the activity. If activities for a visit cross midnight and occur in two separate dates, then two sessions (one per date) share the session identifier. For example, say session ID 113472 has activity within 2019-08-20, and session ID 243742 has activity within 2019-08-25 and 2019-08-26. Session ID 113472 is one session, and session ID 243742 is two sessions.",
"format": "google-datetime",
"type": "string"
},
"activityType": {
"description": "Type of this activity.",
"enum": [
"ACTIVITY_TYPE_UNSPECIFIED",
"PAGEVIEW",
"SCREENVIEW",
"GOAL",
"ECOMMERCE",
"EVENT"
],
"enumDescriptions": [
"ActivityType will never have this value in the response. Using this type in the request will result in an error.",
"Used when the activity resulted out of a visitor viewing a page.",
"Used when the activity resulted out of a visitor using an application on a mobile device.",
"Used to denote that a goal type activity.",
"An e-commerce transaction was performed by the visitor on the page.",
"Used when the activity is an event."
],
"type": "string"
},
"appview": {
"$ref": "ScreenviewData",
"description": "This will be set if `activity_type` equals `SCREEN_VIEW`."
},
"campaign": {
"description": "For manual campaign tracking, it is the value of the utm_campaign campaign tracking parameter. For AdWords autotagging, it is the name(s) of the online ad campaign(s) you use for the property. If you use neither, its value is (not set).",
"type": "string"
},
"channelGrouping": {
"description": "The Channel Group associated with an end user's session for this View (defined by the View's Channel Groupings).",
"type": "string"
},
"customDimension": {
"description": "A list of all custom dimensions associated with this activity.",
"items": {
"$ref": "CustomDimension"
},
"type": "array"
},
"ecommerce": {
"$ref": "EcommerceData",
"description": "This will be set if `activity_type` equals `ECOMMERCE`."
},
"event": {
"$ref": "EventData",
"description": "This field contains all the details pertaining to an event and will be set if `activity_type` equals `EVENT`."
},
"goals": {
"$ref": "GoalSetData",
"description": "This field contains a list of all the goals that were reached in this activity when `activity_type` equals `GOAL`."
},
"hostname": {
"description": "The hostname from which the tracking request was made.",
"type": "string"
},
"keyword": {
"description": "For manual campaign tracking, it is the value of the utm_term campaign tracking parameter. For AdWords traffic, it contains the best matching targeting criteria. For the display network, where multiple targeting criteria could have caused the ad to show up, it returns the best matching targeting criteria as selected by Ads. This could be display_keyword, site placement, boomuserlist, user_interest, age, or gender. Otherwise its value is (not set).",
"type": "string"
},
"landingPagePath": {
"description": "The first page in users' sessions, or the landing page.",
"type": "string"
},
"medium": {
"description": "The type of referrals. For manual campaign tracking, it is the value of the utm_medium campaign tracking parameter. For AdWords autotagging, it is cpc. If users came from a search engine detected by Google Analytics, it is organic. If the referrer is not a search engine, it is referral. If users came directly to the property and document.referrer is empty, its value is (none).",
"type": "string"
},
"pageview": {
"$ref": "PageviewData",
"description": "This will be set if `activity_type` equals `PAGEVIEW`. This field contains all the details about the visitor and the page that was visited."
},
"source": {
"description": "The source of referrals. For manual campaign tracking, it is the value of the utm_source campaign tracking parameter. For AdWords autotagging, it is google. If you use neither, it is the domain of the source (e.g., document.referrer) referring the users. It may also contain a port address. If users arrived without a referrer, its value is (direct).",
"type": "string"
}
},
"type": "object"
},
"Cohort": {
"description": "Defines a cohort. A cohort is a group of users who share a common characteristic. For example, all users with the same acquisition date belong to the same cohort.",
"id": "Cohort",
"properties": {
"dateRange": {
"$ref": "DateRange",
"description": "This is used for `FIRST_VISIT_DATE` cohort, the cohort selects users whose first visit date is between start date and end date defined in the DateRange. The date ranges should be aligned for cohort requests. If the request contains `ga:cohortNthDay` it should be exactly one day long, if `ga:cohortNthWeek` it should be aligned to the week boundary (starting at Sunday and ending Saturday), and for `ga:cohortNthMonth` the date range should be aligned to the month (starting at the first and ending on the last day of the month). For LTV requests there are no such restrictions. You do not need to supply a date range for the `reportsRequest.dateRanges` field."
},
"name": {
"description": "A unique name for the cohort. If not defined name will be auto-generated with values cohort_[1234...].",
"type": "string"
},
"type": {
"description": "Type of the cohort. The only supported type as of now is `FIRST_VISIT_DATE`. If this field is unspecified the cohort is treated as `FIRST_VISIT_DATE` type cohort.",
"enum": [
"UNSPECIFIED_COHORT_TYPE",
"FIRST_VISIT_DATE"
],
"enumDescriptions": [
"If unspecified it's treated as `FIRST_VISIT_DATE`.",
"Cohorts that are selected based on first visit date."
],
"type": "string"
}
},
"type": "object"
},
"CohortGroup": {
"description": "Defines a cohort group. For example: \"cohortGroup\": { \"cohorts\": [{ \"name\": \"cohort 1\", \"type\": \"FIRST_VISIT_DATE\", \"dateRange\": { \"startDate\": \"2015-08-01\", \"endDate\": \"2015-08-01\" } },{ \"name\": \"cohort 2\" \"type\": \"FIRST_VISIT_DATE\" \"dateRange\": { \"startDate\": \"2015-07-01\", \"endDate\": \"2015-07-01\" } }] }",
"id": "CohortGroup",
"properties": {
"cohorts": {
"description": "The definition for the cohort.",
"items": {
"$ref": "Cohort"
},
"type": "array"
},
"lifetimeValue": {
"description": "Enable Life Time Value (LTV). LTV measures lifetime value for users acquired through different channels. Please see: [Cohort Analysis](https://support.google.com/analytics/answer/6074676) and [Lifetime Value](https://support.google.com/analytics/answer/6182550) If the value of lifetimeValue is false: - The metric values are similar to the values in the web interface cohort report. - The cohort definition date ranges must be aligned to the calendar week and month. i.e. while requesting `ga:cohortNthWeek` the `startDate` in the cohort definition should be a Sunday and the `endDate` should be the following Saturday, and for `ga:cohortNthMonth`, the `startDate` should be the 1st of the month and `endDate` should be the last day of the month. When the lifetimeValue is true: - The metric values will correspond to the values in the web interface LifeTime value report. - The Lifetime Value report shows you how user value (Revenue) and engagement (Appviews, Goal Completions, Sessions, and Session Duration) grow during the 90 days after a user is acquired. - The metrics are calculated as a cumulative average per user per the time increment. - The cohort definition date ranges need not be aligned to the calendar week and month boundaries. - The `viewId` must be an [app view ID](https://support.google.com/analytics/answer/2649553#WebVersusAppViews)",
"type": "boolean"
}
},
"type": "object"
},
"ColumnHeader": {
"description": "Column headers.",
"id": "ColumnHeader",
"properties": {
"dimensions": {
"description": "The dimension names in the response.",
"items": {
"type": "string"
},
"type": "array"
},
"metricHeader": {
"$ref": "MetricHeader",
"description": "Metric headers for the metrics in the response."
}
},
"type": "object"
},
"CustomDimension": {
"description": "Custom dimension.",
"id": "CustomDimension",
"properties": {
"index": {
"description": "Slot number of custom dimension.",
"format": "int32",
"type": "integer"
},
"value": {
"description": "Value of the custom dimension. Default value (i.e. empty string) indicates clearing sesion/visitor scope custom dimension value.",
"type": "string"
}
},
"type": "object"
},
"DateRange": {
"description": "A contiguous set of days: startDate, startDate + 1 day, ..., endDate. The start and end dates are specified in [ISO8601](https://en.wikipedia.org/wiki/ISO_8601) date format `YYYY-MM-DD`.",
"id": "DateRange",
"properties": {
"endDate": {
"description": "The end date for the query in the format `YYYY-MM-DD`.",
"type": "string"
},
"startDate": {
"description": "The start date for the query in the format `YYYY-MM-DD`.",
"type": "string"
}
},
"type": "object"
},
"DateRangeValues": {
"description": "Used to return a list of metrics for a single DateRange / dimension combination",
"id": "DateRangeValues",
"properties": {
"pivotValueRegions": {
"description": "The values of each pivot region.",
"items": {
"$ref": "PivotValueRegion"
},
"type": "array"
},
"values": {
"description": "Each value corresponds to each Metric in the request.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"Dimension": {
"description": "[Dimensions](https://support.google.com/analytics/answer/1033861) are attributes of your data. For example, the dimension `ga:city` indicates the city, for example, \"Paris\" or \"New York\", from which a session originates.",
"id": "Dimension",
"properties": {
"histogramBuckets": {
"description": "If non-empty, we place dimension values into buckets after string to int64. Dimension values that are not the string representation of an integral value will be converted to zero. The bucket values have to be in increasing order. Each bucket is closed on the lower end, and open on the upper end. The \"first\" bucket includes all values less than the first boundary, the \"last\" bucket includes all values up to infinity. Dimension values that fall in a bucket get transformed to a new dimension value. For example, if one gives a list of \"0, 1, 3, 4, 7\", then we return the following buckets: - bucket #1: values \u003c 0, dimension value \"\u003c0\" - bucket #2: values in [0,1), dimension value \"0\" - bucket #3: values in [1,3), dimension value \"1-2\" - bucket #4: values in [3,4), dimension value \"3\" - bucket #5: values in [4,7), dimension value \"4-6\" - bucket #6: values \u003e= 7, dimension value \"7+\" NOTE: If you are applying histogram mutation on any dimension, and using that dimension in sort, you will want to use the sort type `HISTOGRAM_BUCKET` for that purpose. Without that the dimension values will be sorted according to dictionary (lexicographic) order. For example the ascending dictionary order is: \"\u003c50\", \"1001+\", \"121-1000\", \"50-120\" And the ascending `HISTOGRAM_BUCKET` order is: \"\u003c50\", \"50-120\", \"121-1000\", \"1001+\" The client has to explicitly request `\"orderType\": \"HISTOGRAM_BUCKET\"` for a histogram-mutated dimension.",
"items": {
"format": "int64",
"type": "string"
},
"type": "array"
},
"name": {
"description": "Name of the dimension to fetch, for example `ga:browser`.",
"type": "string"
}
},
"type": "object"
},
"DimensionFilter": {
"description": "Dimension filter specifies the filtering options on a dimension.",
"id": "DimensionFilter",
"properties": {
"caseSensitive": {
"description": "Should the match be case sensitive? Default is false.",
"type": "boolean"
},
"dimensionName": {
"description": "The dimension to filter on. A DimensionFilter must contain a dimension.",
"type": "string"
},
"expressions": {
"description": "Strings or regular expression to match against. Only the first value of the list is used for comparison unless the operator is `IN_LIST`. If `IN_LIST` operator, then the entire list is used to filter the dimensions as explained in the description of the `IN_LIST` operator.",
"items": {
"type": "string"
},
"type": "array"
},
"not": {
"description": "Logical `NOT` operator. If this boolean is set to true, then the matching dimension values will be excluded in the report. The default is false.",
"type": "boolean"
},
"operator": {
"description": "How to match the dimension to the expression. The default is REGEXP.",
"enum": [
"OPERATOR_UNSPECIFIED",
"REGEXP",
"BEGINS_WITH",
"ENDS_WITH",
"PARTIAL",
"EXACT",
"NUMERIC_EQUAL",
"NUMERIC_GREATER_THAN",
"NUMERIC_LESS_THAN",
"IN_LIST"
],
"enumDescriptions": [
"If the match type is unspecified, it is treated as a `REGEXP`.",
"The match expression is treated as a regular expression. All match types are not treated as regular expressions.",
"Matches the value which begin with the match expression provided.",
"Matches the values which end with the match expression provided.",
"Substring match.",
"The value should match the match expression entirely.",
"Integer comparison filters. case sensitivity is ignored for these and the expression is assumed to be a string representing an integer. Failure conditions: - If expression is not a valid int64, the client should expect an error. - Input dimensions that are not valid int64 values will never match the filter.",
"Checks if the dimension is numerically greater than the match expression. Read the description for `NUMERIC_EQUALS` for restrictions.",
"Checks if the dimension is numerically less than the match expression. Read the description for `NUMERIC_EQUALS` for restrictions.",
"This option is used to specify a dimension filter whose expression can take any value from a selected list of values. This helps avoiding evaluating multiple exact match dimension filters which are OR'ed for every single response row. For example: expressions: [\"A\", \"B\", \"C\"] Any response row whose dimension has it is value as A, B or C, matches this DimensionFilter."
],
"type": "string"
}
},
"type": "object"
},
"DimensionFilterClause": {
"description": "A group of dimension filters. Set the operator value to specify how the filters are logically combined.",
"id": "DimensionFilterClause",
"properties": {
"filters": {
"description": "The repeated set of filters. They are logically combined based on the operator specified.",
"items": {
"$ref": "DimensionFilter"
},
"type": "array"
},
"operator": {
"description": "The operator for combining multiple dimension filters. If unspecified, it is treated as an `OR`.",
"enum": [
"OPERATOR_UNSPECIFIED",
"OR",
"AND"
],
"enumDescriptions": [
"Unspecified operator. It is treated as an `OR`.",
"The logical `OR` operator.",
"The logical `AND` operator."
],
"type": "string"
}
},
"type": "object"
},
"DynamicSegment": {
"description": "Dynamic segment definition for defining the segment within the request. A segment can select users, sessions or both.",
"id": "DynamicSegment",
"properties": {
"name": {
"description": "The name of the dynamic segment.",
"type": "string"
},
"sessionSegment": {
"$ref": "SegmentDefinition",
"description": "Session Segment to select sessions to include in the segment."
},
"userSegment": {
"$ref": "SegmentDefinition",
"description": "User Segment to select users to include in the segment."
}
},
"type": "object"
},
"EcommerceData": {
"description": "E-commerce details associated with the user activity.",
"id": "EcommerceData",
"properties": {
"actionType": {
"description": "Action associated with this e-commerce action.",
"enum": [
"UNKNOWN",
"CLICK",
"DETAILS_VIEW",
"ADD_TO_CART",
"REMOVE_FROM_CART",
"CHECKOUT",
"PAYMENT",
"REFUND",
"CHECKOUT_OPTION"
],
"enumDescriptions": [
"Action type is not known.",
"Click through of product lists.",
"Product detail views.",
"Add product(s) to cart.",
"Remove product(s) from cart.",
"Check out.",
"Completed purchase.",
"Refund of purchase.",
"Checkout options."
],
"type": "string"
},
"ecommerceType": {
"description": "The type of this e-commerce activity.",
"enum": [
"ECOMMERCE_TYPE_UNSPECIFIED",
"CLASSIC",
"ENHANCED"
],
"enumDescriptions": [
"Used when the e-commerce activity type is unspecified.",
"Used when activity has classic (non-enhanced) e-commerce information.",
"Used when activity has enhanced e-commerce information."
],
"type": "string"
},
"products": {
"description": "Details of the products in this transaction.",
"items": {
"$ref": "ProductData"
},
"type": "array"
},
"transaction": {
"$ref": "TransactionData",
"description": "Transaction details of this e-commerce action."
}
},
"type": "object"
},
"EventData": {
"description": "Represents all the details pertaining to an event.",
"id": "EventData",
"properties": {
"eventAction": {
"description": "Type of interaction with the object. Eg: 'play'.",
"type": "string"
},
"eventCategory": {
"description": "The object on the page that was interacted with. Eg: 'Video'.",
"type": "string"
},
"eventCount": {
"description": "Number of such events in this activity.",
"format": "int64",
"type": "string"
},
"eventLabel": {
"description": "Label attached with the event.",
"type": "string"
},
"eventValue": {
"description": "Numeric value associated with the event.",
"format": "int64",
"type": "string"
}
},
"type": "object"
},
"GetReportsRequest": {
"description": "The batch request containing multiple report request.",
"id": "GetReportsRequest",
"properties": {
"reportRequests": {
"description": "Requests, each request will have a separate response. There can be a maximum of 5 requests. All requests should have the same `dateRanges`, `viewId`, `segments`, `samplingLevel`, and `cohortGroup`.",
"items": {
"$ref": "ReportRequest"
},
"type": "array"
},
"useResourceQuotas": {
"description": "Enables [resource based quotas](/analytics/devguides/reporting/core/v4/limits-quotas#analytics_reporting_api_v4), (defaults to `False`). If this field is set to `True` the per view (profile) quotas are governed by the computational cost of the request. Note that using cost based quotas will higher enable sampling rates. (10 Million for `SMALL`, 100M for `LARGE`. See the [limits and quotas documentation](/analytics/devguides/reporting/core/v4/limits-quotas#analytics_reporting_api_v4) for details.",
"type": "boolean"
}
},
"type": "object"
},
"GetReportsResponse": {
"description": "The main response class which holds the reports from the Reporting API `batchGet` call.",
"id": "GetReportsResponse",
"properties": {
"queryCost": {
"description": "The amount of resource quota tokens deducted to execute the query. Includes all responses.",
"format": "int32",
"type": "integer"
},
"reports": {
"description": "Responses corresponding to each of the request.",
"items": {
"$ref": "Report"
},
"type": "array"
},
"resourceQuotasRemaining": {
"$ref": "ResourceQuotasRemaining",
"description": "The amount of resource quota remaining for the property."
}
},
"type": "object"
},
"GoalData": {
"description": "Represents all the details pertaining to a goal.",
"id": "GoalData",
"properties": {
"goalCompletionLocation": {
"description": "URL of the page where this goal was completed.",
"type": "string"
},
"goalCompletions": {
"description": "Total number of goal completions in this activity.",
"format": "int64",
"type": "string"
},
"goalIndex": {
"description": "This identifies the goal as configured for the profile.",
"format": "int32",
"type": "integer"
},
"goalName": {
"description": "Name of the goal.",
"type": "string"
},
"goalPreviousStep1": {
"description": "URL of the page one step prior to the goal completion.",
"type": "string"
},
"goalPreviousStep2": {
"description": "URL of the page two steps prior to the goal completion.",
"type": "string"
},
"goalPreviousStep3": {
"description": "URL of the page three steps prior to the goal completion.",
"type": "string"
},
"goalValue": {
"description": "Value in this goal.",
"format": "double",
"type": "number"
}
},
"type": "object"
},
"GoalSetData": {
"description": "Represents a set of goals that were reached in an activity.",
"id": "GoalSetData",
"properties": {
"goals": {
"description": "All the goals that were reached in the current activity.",
"items": {
"$ref": "GoalData"
},
"type": "array"
}
},
"type": "object"
},
"Metric": {
"description": "[Metrics](https://support.google.com/analytics/answer/1033861) are the quantitative measurements. For example, the metric `ga:users` indicates 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 expression. The alias can be used for filtering and sorting. This field is optional and is useful if the expression is not a single metric but a complex expression which cannot be used in filtering and sorting. The alias is also used in the response column header.",
"type": "string"
},
"expression": {
"description": "A metric expression in the request. An expression is constructed from one or more metrics and numbers. Accepted operators include: Plus (+), Minus (-), Negation (Unary -), Divided by (/), Multiplied by (*), Parenthesis, Positive cardinal numbers (0-9), can include decimals and is limited to 1024 characters. Example `ga:totalRefunds/ga:users`, in most cases the metric expression is just a single metric name like `ga:users`. Adding mixed `MetricType` (E.g., `CURRENCY` + `PERCENTAGE`) metrics will result in unexpected results.",
"type": "string"
},
"formattingType": {
"description": "Specifies how the metric expression should be formatted, for example `INTEGER`.",
"enum": [
"METRIC_TYPE_UNSPECIFIED",
"INTEGER",
"FLOAT",
"CURRENCY",
"PERCENT",
"TIME"
],
"enumDescriptions": [
"Metric type is unspecified.",
"Integer metric.",
"Float metric.",
"Currency metric.",
"Percentage metric.",
"Time metric in `HH:MM:SS` format."
],
"type": "string"
}
},
"type": "object"
},
"MetricFilter": {
"description": "MetricFilter specifies the filter on a metric.",
"id": "MetricFilter",
"properties": {
"comparisonValue": {
"description": "The value to compare against.",
"type": "string"
},
"metricName": {
"description": "The metric that will be filtered on. A metricFilter must contain a metric name. A metric name can be an alias earlier defined as a metric or it can also be a metric expression.",
"type": "string"
},
"not": {
"description": "Logical `NOT` operator. If this boolean is set to true, then the matching metric values will be excluded in the report. The default is false.",
"type": "boolean"
},
"operator": {
"description": "Is the metric `EQUAL`, `LESS_THAN` or `GREATER_THAN` the comparisonValue, the default is `EQUAL`. If the operator is `IS_MISSING`, checks if the metric is missing and would ignore the comparisonValue.",
"enum": [
"OPERATOR_UNSPECIFIED",
"EQUAL",
"LESS_THAN",
"GREATER_THAN",
"IS_MISSING"
],
"enumDescriptions": [
"If the operator is not specified, it is treated as `EQUAL`.",
"Should the value of the metric be exactly equal to the comparison value.",
"Should the value of the metric be less than to the comparison value.",
"Should the value of the metric be greater than to the comparison value.",
"Validates if the metric is missing. Doesn't take comparisonValue into account."
],
"type": "string"
}
},
"type": "object"
},
"MetricFilterClause": {
"description": "Represents a group of metric filters. Set the operator value to specify how the filters are logically combined.",
"id": "MetricFilterClause",
"properties": {
"filters": {
"description": "The repeated set of filters. They are logically combined based on the operator specified.",
"items": {
"$ref": "MetricFilter"
},
"type": "array"
},
"operator": {
"description": "The operator for combining multiple metric filters. If unspecified, it is treated as an `OR`.",
"enum": [
"OPERATOR_UNSPECIFIED",
"OR",
"AND"
],
"enumDescriptions": [
"Unspecified operator. It is treated as an `OR`.",
"The logical `OR` operator.",
"The logical `AND` operator."
],
"type": "string"
}
},
"type": "object"
},
"MetricHeader": {
"description": "The headers for the metrics.",
"id": "MetricHeader",
"properties": {
"metricHeaderEntries": {
"description": "Headers for the metrics in the response.",
"items": {
"$ref": "MetricHeaderEntry"
},
"type": "array"
},
"pivotHeaders": {
"description": "Headers for the pivots in the response.",
"items": {
"$ref": "PivotHeader"
},
"type": "array"
}
},
"type": "object"
},
"MetricHeaderEntry": {
"description": "Header for the metrics.",
"id": "MetricHeaderEntry",
"properties": {
"name": {
"description": "The name of the header.",
"type": "string"
},
"type": {
"description": "The type of the metric, for example `INTEGER`.",
"enum": [
"METRIC_TYPE_UNSPECIFIED",
"INTEGER",
"FLOAT",
"CURRENCY",
"PERCENT",
"TIME"
],
"enumDescriptions": [
"Metric type is unspecified.",
"Integer metric.",
"Float metric.",
"Currency metric.",
"Percentage metric.",
"Time metric in `HH:MM:SS` format."
],
"type": "string"
}
},
"type": "object"
},
"OrFiltersForSegment": {
"description": "A list of segment filters in the `OR` group are combined with the logical OR operator.",
"id": "OrFiltersForSegment",
"properties": {
"segmentFilterClauses": {
"description": "List of segment filters to be combined with a `OR` operator.",
"items": {
"$ref": "SegmentFilterClause"
},
"type": "array"
}
},
"type": "object"
},
"OrderBy": {
"description": "Specifies the sorting options.",
"id": "OrderBy",
"properties": {
"fieldName": {
"description": "The field which to sort by. The default sort order is ascending. Example: `ga:browser`. Note, that you can only specify one field for sort here. For example, `ga:browser, ga:city` is not valid.",
"type": "string"
},
"orderType": {
"description": "The order type. The default orderType is `VALUE`.",
"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 the first date range.",
"The sort order is based on the difference of the values of the chosen column between the first two date ranges. Usable only if there are exactly two date ranges.",
"The sort order is based on weighted value of the chosen column. If column has n/d format, then weighted value of this ratio will be `(n + totals.n)/(d + totals.d)` Usable only for metrics that represent ratios.",
"Histogram order type is applicable only to dimension columns with non-empty histogram-buckets.",
"If the dimensions are fixed length numbers, ordinary sort would just work fine. `DIMENSION_AS_INTEGER` can be used if the dimensions are variable length numbers."
],
"type": "string"
},
"sortOrder": {
"description": "The sorting order for the field.",
"enum": [
"SORT_ORDER_UNSPECIFIED",
"ASCENDING",
"DESCENDING"
],
"enumDescriptions": [
"If the sort order is unspecified, the default is ascending.",
"Ascending sort. The field will be sorted in an ascending manner.",
"Descending sort. The field will be sorted in a descending manner."
],
"type": "string"
}
},
"type": "object"
},
"PageviewData": {
"description": "Represents details collected when the visitor views a page.",
"id": "PageviewData",
"properties": {
"pagePath": {
"description": "The URL of the page that the visitor viewed.",
"type": "string"
},
"pageTitle": {
"description": "The title of the page that the visitor viewed.",
"type": "string"
}
},
"type": "object"
},
"Pivot": {
"description": "The Pivot describes the pivot section in the request. The Pivot helps rearrange the information in the table for certain reports by pivoting your data on a second dimension.",
"id": "Pivot",
"properties": {
"dimensionFilterClauses": {
"description": "DimensionFilterClauses are logically combined with an `AND` operator: only data that is included by all these DimensionFilterClauses contributes to the values in this pivot region. Dimension filters can be used to restrict the columns shown in the pivot region. For example if you have `ga:browser` as the requested dimension in the pivot region, and you specify key filters to restrict `ga:browser` to only \"IE\" or \"Firefox\", then only those two browsers would show up as columns.",
"items": {
"$ref": "DimensionFilterClause"
},
"type": "array"
},
"dimensions": {
"description": "A list of dimensions to show as pivot columns. A Pivot can have a maximum of 4 dimensions. Pivot dimensions are part of the restriction on the total number of dimensions allowed in the request.",
"items": {
"$ref": "Dimension"
},
"type": "array"
},
"maxGroupCount": {
"description": "Specifies the maximum number of groups to return. The default value is 10, also the maximum value is 1,000.",
"format": "int32",
"type": "integer"
},
"metrics": {
"description": "The pivot metrics. Pivot metrics are part of the restriction on total number of metrics allowed in the request.",
"items": {
"$ref": "Metric"
},
"type": "array"
},
"startGroup": {
"description": "If k metrics were requested, then the response will contain some data-dependent multiple of k columns in the report. E.g., if you pivoted on the dimension `ga:browser` then you'd get k columns for \"Firefox\", k columns for \"IE\", k columns for \"Chrome\", etc. The ordering of the groups of columns is determined by descending order of \"total\" for the first of the k values. Ties are broken by lexicographic ordering of the first pivot dimension, then lexicographic ordering of the second pivot dimension, and so on. E.g., if the totals for the first value for Firefox, IE, and Chrome were 8, 2, 8, respectively, the order of columns would be Chrome, Firefox, IE. The following let you choose which of the groups of k columns are included in the response.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"PivotHeader": {
"description": "The headers for each of the pivot sections defined in the request.",
"id": "PivotHeader",
"properties": {
"pivotHeaderEntries": {
"description": "A single pivot section header.",
"items": {
"$ref": "PivotHeaderEntry"
},
"type": "array"
},
"totalPivotGroupsCount": {
"description": "The total number of groups for this pivot.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"PivotHeaderEntry": {
"description": "The headers for the each of the metric column corresponding to the metrics requested in the pivots section of the response.",
"id": "PivotHeaderEntry",
"properties": {
"dimensionNames": {
"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"
},
"type": "array"
},
"metric": {
"$ref": "MetricHeaderEntry",
"description": "The metric header for the metric in the pivot."
}
},
"type": "object"
},
"PivotValueRegion": {
"description": "The metric values in the pivot region.",
"id": "PivotValueRegion",
"properties": {
"values": {
"description": "The values of the metrics in each of the pivot regions.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"ProductData": {
"description": "Details of the products in an e-commerce transaction.",
"id": "ProductData",
"properties": {
"itemRevenue": {
"description": "The total revenue from purchased product items.",
"format": "double",
"type": "number"
},
"productName": {
"description": "The product name, supplied by the e-commerce tracking application, for the purchased items.",
"type": "string"