/
analyticsdata-api.json
1850 lines (1850 loc) · 86.8 KB
/
analyticsdata-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://analyticsdata.googleapis.com/",
"batchPath": "batch",
"canonicalName": "AnalyticsData",
"description": "Accesses report data in Google Analytics.",
"discoveryVersion": "v1",
"documentationLink": "https://developers.google.com/analytics/devguides/reporting/data/v1/",
"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": "analyticsdata:v1beta",
"kind": "discovery#restDescription",
"mtlsRootUrl": "https://analyticsdata.mtls.googleapis.com/",
"name": "analyticsdata",
"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": {
"properties": {
"methods": {
"batchRunPivotReports": {
"description": "Returns multiple pivot reports in a batch. All reports must be for the same GA4 Property.",
"flatPath": "v1beta/properties/{propertiesId}:batchRunPivotReports",
"httpMethod": "POST",
"id": "analyticsdata.properties.batchRunPivotReports",
"parameterOrder": [
"property"
],
"parameters": {
"property": {
"description": "A Google Analytics GA4 property identifier whose events are tracked. Specified in the URL path and not the body. To learn more, see [where to find your Property ID](https://developers.google.com/analytics/devguides/reporting/data/v1/property-id). This property must be specified for the batch. The property within RunPivotReportRequest may either be unspecified or consistent with this property. Example: properties/1234",
"location": "path",
"pattern": "^properties/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+property}:batchRunPivotReports",
"request": {
"$ref": "BatchRunPivotReportsRequest"
},
"response": {
"$ref": "BatchRunPivotReportsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/analytics",
"https://www.googleapis.com/auth/analytics.readonly"
]
},
"batchRunReports": {
"description": "Returns multiple reports in a batch. All reports must be for the same GA4 Property.",
"flatPath": "v1beta/properties/{propertiesId}:batchRunReports",
"httpMethod": "POST",
"id": "analyticsdata.properties.batchRunReports",
"parameterOrder": [
"property"
],
"parameters": {
"property": {
"description": "A Google Analytics GA4 property identifier whose events are tracked. Specified in the URL path and not the body. To learn more, see [where to find your Property ID](https://developers.google.com/analytics/devguides/reporting/data/v1/property-id). This property must be specified for the batch. The property within RunReportRequest may either be unspecified or consistent with this property. Example: properties/1234",
"location": "path",
"pattern": "^properties/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+property}:batchRunReports",
"request": {
"$ref": "BatchRunReportsRequest"
},
"response": {
"$ref": "BatchRunReportsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/analytics",
"https://www.googleapis.com/auth/analytics.readonly"
]
},
"checkCompatibility": {
"description": "This compatibility method lists dimensions and metrics that can be added to a report request and maintain compatibility. This method fails if the request's dimensions and metrics are incompatible. In Google Analytics, reports fail if they request incompatible dimensions and/or metrics; in that case, you will need to remove dimensions and/or metrics from the incompatible report until the report is compatible. The Realtime and Core reports have different compatibility rules. This method checks compatibility for Core reports.",
"flatPath": "v1beta/properties/{propertiesId}:checkCompatibility",
"httpMethod": "POST",
"id": "analyticsdata.properties.checkCompatibility",
"parameterOrder": [
"property"
],
"parameters": {
"property": {
"description": "A Google Analytics GA4 property identifier whose events are tracked. To learn more, see [where to find your Property ID](https://developers.google.com/analytics/devguides/reporting/data/v1/property-id). `property` should be the same value as in your `runReport` request. Example: properties/1234",
"location": "path",
"pattern": "^properties/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+property}:checkCompatibility",
"request": {
"$ref": "CheckCompatibilityRequest"
},
"response": {
"$ref": "CheckCompatibilityResponse"
},
"scopes": [
"https://www.googleapis.com/auth/analytics",
"https://www.googleapis.com/auth/analytics.readonly"
]
},
"getMetadata": {
"description": "Returns metadata for dimensions and metrics available in reporting methods. Used to explore the dimensions and metrics. In this method, a Google Analytics GA4 Property Identifier is specified in the request, and the metadata response includes Custom dimensions and metrics as well as Universal metadata. For example if a custom metric with parameter name `levels_unlocked` is registered to a property, the Metadata response will contain `customEvent:levels_unlocked`. Universal metadata are dimensions and metrics applicable to any property such as `country` and `totalUsers`.",
"flatPath": "v1beta/properties/{propertiesId}/metadata",
"httpMethod": "GET",
"id": "analyticsdata.properties.getMetadata",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The resource name of the metadata to retrieve. This name field is specified in the URL path and not URL parameters. Property is a numeric Google Analytics GA4 Property identifier. To learn more, see [where to find your Property ID](https://developers.google.com/analytics/devguides/reporting/data/v1/property-id). Example: properties/1234/metadata Set the Property ID to 0 for dimensions and metrics common to all properties. In this special mode, this method will not return custom dimensions and metrics.",
"location": "path",
"pattern": "^properties/[^/]+/metadata$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+name}",
"response": {
"$ref": "Metadata"
},
"scopes": [
"https://www.googleapis.com/auth/analytics",
"https://www.googleapis.com/auth/analytics.readonly"
]
},
"runPivotReport": {
"description": "Returns a customized pivot report of your Google Analytics event data. Pivot reports are more advanced and expressive formats than regular reports. In a pivot report, dimensions are only visible if they are included in a pivot. Multiple pivots can be specified to further dissect your data.",
"flatPath": "v1beta/properties/{propertiesId}:runPivotReport",
"httpMethod": "POST",
"id": "analyticsdata.properties.runPivotReport",
"parameterOrder": [
"property"
],
"parameters": {
"property": {
"description": "A Google Analytics GA4 property identifier whose events are tracked. Specified in the URL path and not the body. To learn more, see [where to find your Property ID](https://developers.google.com/analytics/devguides/reporting/data/v1/property-id). Within a batch request, this property should either be unspecified or consistent with the batch-level property. Example: properties/1234",
"location": "path",
"pattern": "^properties/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+property}:runPivotReport",
"request": {
"$ref": "RunPivotReportRequest"
},
"response": {
"$ref": "RunPivotReportResponse"
},
"scopes": [
"https://www.googleapis.com/auth/analytics",
"https://www.googleapis.com/auth/analytics.readonly"
]
},
"runRealtimeReport": {
"description": "Returns a customized report of realtime event data for your property. Events appear in realtime reports seconds after they have been sent to the Google Analytics. Realtime reports show events and usage data for the periods of time ranging from the present moment to 30 minutes ago (up to 60 minutes for Google Analytics 360 properties). For a guide to constructing realtime requests \u0026 understanding responses, see [Creating a Realtime Report](https://developers.google.com/analytics/devguides/reporting/data/v1/realtime-basics).",
"flatPath": "v1beta/properties/{propertiesId}:runRealtimeReport",
"httpMethod": "POST",
"id": "analyticsdata.properties.runRealtimeReport",
"parameterOrder": [
"property"
],
"parameters": {
"property": {
"description": "A Google Analytics GA4 property identifier whose events are tracked. Specified in the URL path and not the body. To learn more, see [where to find your Property ID](https://developers.google.com/analytics/devguides/reporting/data/v1/property-id). Example: properties/1234",
"location": "path",
"pattern": "^properties/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+property}:runRealtimeReport",
"request": {
"$ref": "RunRealtimeReportRequest"
},
"response": {
"$ref": "RunRealtimeReportResponse"
},
"scopes": [
"https://www.googleapis.com/auth/analytics",
"https://www.googleapis.com/auth/analytics.readonly"
]
},
"runReport": {
"description": "Returns a customized report of your Google Analytics event data. Reports contain statistics derived from data collected by the Google Analytics tracking code. The data returned from the API is as a table with columns for the requested dimensions and metrics. Metrics are individual measurements of user activity on your property, such as active users or event count. Dimensions break down metrics across some common criteria, such as country or event name. For a guide to constructing requests \u0026 understanding responses, see [Creating a Report](https://developers.google.com/analytics/devguides/reporting/data/v1/basics).",
"flatPath": "v1beta/properties/{propertiesId}:runReport",
"httpMethod": "POST",
"id": "analyticsdata.properties.runReport",
"parameterOrder": [
"property"
],
"parameters": {
"property": {
"description": "A Google Analytics GA4 property identifier whose events are tracked. Specified in the URL path and not the body. To learn more, see [where to find your Property ID](https://developers.google.com/analytics/devguides/reporting/data/v1/property-id). Within a batch request, this property should either be unspecified or consistent with the batch-level property. Example: properties/1234",
"location": "path",
"pattern": "^properties/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+property}:runReport",
"request": {
"$ref": "RunReportRequest"
},
"response": {
"$ref": "RunReportResponse"
},
"scopes": [
"https://www.googleapis.com/auth/analytics",
"https://www.googleapis.com/auth/analytics.readonly"
]
}
}
}
},
"revision": "20230214",
"rootUrl": "https://analyticsdata.googleapis.com/",
"schemas": {
"ActiveMetricRestriction": {
"description": "A metric actively restricted in creating the report.",
"id": "ActiveMetricRestriction",
"properties": {
"metricName": {
"description": "The name of the restricted metric.",
"type": "string"
},
"restrictedMetricTypes": {
"description": "The reason for this metric's restriction.",
"items": {
"enum": [
"RESTRICTED_METRIC_TYPE_UNSPECIFIED",
"COST_DATA",
"REVENUE_DATA"
],
"enumDescriptions": [
"Unspecified type.",
"Cost metrics such as `adCost`.",
"Revenue metrics such as `purchaseRevenue`."
],
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"BatchRunPivotReportsRequest": {
"description": "The batch request containing multiple pivot report requests.",
"id": "BatchRunPivotReportsRequest",
"properties": {
"requests": {
"description": "Individual requests. Each request has a separate pivot report response. Each batch request is allowed up to 5 requests.",
"items": {
"$ref": "RunPivotReportRequest"
},
"type": "array"
}
},
"type": "object"
},
"BatchRunPivotReportsResponse": {
"description": "The batch response containing multiple pivot reports.",
"id": "BatchRunPivotReportsResponse",
"properties": {
"kind": {
"description": "Identifies what kind of resource this message is. This `kind` is always the fixed string \"analyticsData#batchRunPivotReports\". Useful to distinguish between response types in JSON.",
"type": "string"
},
"pivotReports": {
"description": "Individual responses. Each response has a separate pivot report request.",
"items": {
"$ref": "RunPivotReportResponse"
},
"type": "array"
}
},
"type": "object"
},
"BatchRunReportsRequest": {
"description": "The batch request containing multiple report requests.",
"id": "BatchRunReportsRequest",
"properties": {
"requests": {
"description": "Individual requests. Each request has a separate report response. Each batch request is allowed up to 5 requests.",
"items": {
"$ref": "RunReportRequest"
},
"type": "array"
}
},
"type": "object"
},
"BatchRunReportsResponse": {
"description": "The batch response containing multiple reports.",
"id": "BatchRunReportsResponse",
"properties": {
"kind": {
"description": "Identifies what kind of resource this message is. This `kind` is always the fixed string \"analyticsData#batchRunReports\". Useful to distinguish between response types in JSON.",
"type": "string"
},
"reports": {
"description": "Individual responses. Each response has a separate report request.",
"items": {
"$ref": "RunReportResponse"
},
"type": "array"
}
},
"type": "object"
},
"BetweenFilter": {
"description": "To express that the result needs to be between two numbers (inclusive).",
"id": "BetweenFilter",
"properties": {
"fromValue": {
"$ref": "NumericValue",
"description": "Begins with this number."
},
"toValue": {
"$ref": "NumericValue",
"description": "Ends with this number."
}
},
"type": "object"
},
"CaseExpression": {
"description": "Used to convert a dimension value to a single case.",
"id": "CaseExpression",
"properties": {
"dimensionName": {
"description": "Name of a dimension. The name must refer back to a name in dimensions field of the request.",
"type": "string"
}
},
"type": "object"
},
"CheckCompatibilityRequest": {
"description": "The request for compatibility information for a report's dimensions and metrics. Check compatibility provides a preview of the compatibility of a report; fields shared with the `runReport` request should be the same values as in your `runReport` request.",
"id": "CheckCompatibilityRequest",
"properties": {
"compatibilityFilter": {
"description": "Filters the dimensions and metrics in the response to just this compatibility. Commonly used as `”compatibilityFilter”: “COMPATIBLE”` to only return compatible dimensions \u0026 metrics.",
"enum": [
"COMPATIBILITY_UNSPECIFIED",
"COMPATIBLE",
"INCOMPATIBLE"
],
"enumDescriptions": [
"Unspecified compatibility.",
"The dimension or metric is compatible. This dimension or metric can be successfully added to a report.",
"The dimension or metric is incompatible. This dimension or metric cannot be successfully added to a report."
],
"type": "string"
},
"dimensionFilter": {
"$ref": "FilterExpression",
"description": "The filter clause of dimensions. `dimensionFilter` should be the same value as in your `runReport` request."
},
"dimensions": {
"description": "The dimensions in this report. `dimensions` should be the same value as in your `runReport` request.",
"items": {
"$ref": "Dimension"
},
"type": "array"
},
"metricFilter": {
"$ref": "FilterExpression",
"description": "The filter clause of metrics. `metricFilter` should be the same value as in your `runReport` request"
},
"metrics": {
"description": "The metrics in this report. `metrics` should be the same value as in your `runReport` request.",
"items": {
"$ref": "Metric"
},
"type": "array"
}
},
"type": "object"
},
"CheckCompatibilityResponse": {
"description": "The compatibility response with the compatibility of each dimension \u0026 metric.",
"id": "CheckCompatibilityResponse",
"properties": {
"dimensionCompatibilities": {
"description": "The compatibility of each dimension.",
"items": {
"$ref": "DimensionCompatibility"
},
"type": "array"
},
"metricCompatibilities": {
"description": "The compatibility of each metric.",
"items": {
"$ref": "MetricCompatibility"
},
"type": "array"
}
},
"type": "object"
},
"Cohort": {
"description": "Defines a cohort selection criteria. A cohort is a group of users who share a common characteristic. For example, users with the same `firstSessionDate` belong to the same cohort.",
"id": "Cohort",
"properties": {
"dateRange": {
"$ref": "DateRange",
"description": "The cohort selects users whose first touch date is between start date and end date defined in the `dateRange`. This `dateRange` does not specify the full date range of event data that is present in a cohort report. In a cohort report, this `dateRange` is extended by the granularity and offset present in the `cohortsRange`; event data for the extended reporting date range is present in a cohort report. In a cohort request, this `dateRange` is required and the `dateRanges` in the `RunReportRequest` or `RunPivotReportRequest` must be unspecified. This `dateRange` should generally be aligned with the cohort's granularity. If `CohortsRange` uses daily granularity, this `dateRange` can be a single day. If `CohortsRange` uses weekly granularity, this `dateRange` can be aligned to a week boundary, starting at Sunday and ending Saturday. If `CohortsRange` uses monthly granularity, this `dateRange` can be aligned to a month, starting at the first and ending on the last day of the month."
},
"dimension": {
"description": "Dimension used by the cohort. Required and only supports `firstSessionDate`.",
"type": "string"
},
"name": {
"description": "Assigns a name to this cohort. The dimension `cohort` is valued to this name in a report response. If set, cannot begin with `cohort_` or `RESERVED_`. If not set, cohorts are named by their zero based index `cohort_0`, `cohort_1`, etc.",
"type": "string"
}
},
"type": "object"
},
"CohortReportSettings": {
"description": "Optional settings of a cohort report.",
"id": "CohortReportSettings",
"properties": {
"accumulate": {
"description": "If true, accumulates the result from first touch day to the end day. Not supported in `RunReportRequest`.",
"type": "boolean"
}
},
"type": "object"
},
"CohortSpec": {
"description": "The specification of cohorts for a cohort report. Cohort reports create a time series of user retention for the cohort. For example, you could select the cohort of users that were acquired in the first week of September and follow that cohort for the next six weeks. Selecting the users acquired in the first week of September cohort is specified in the `cohort` object. Following that cohort for the next six weeks is specified in the `cohortsRange` object. For examples, see [Cohort Report Examples](https://developers.google.com/analytics/devguides/reporting/data/v1/advanced#cohort_report_examples). The report response could show a weekly time series where say your app has retained 60% of this cohort after three weeks and 25% of this cohort after six weeks. These two percentages can be calculated by the metric `cohortActiveUsers/cohortTotalUsers` and will be separate rows in the report.",
"id": "CohortSpec",
"properties": {
"cohortReportSettings": {
"$ref": "CohortReportSettings",
"description": "Optional settings for a cohort report."
},
"cohorts": {
"description": "Defines the selection criteria to group users into cohorts. Most cohort reports define only a single cohort. If multiple cohorts are specified, each cohort can be recognized in the report by their name.",
"items": {
"$ref": "Cohort"
},
"type": "array"
},
"cohortsRange": {
"$ref": "CohortsRange",
"description": "Cohort reports follow cohorts over an extended reporting date range. This range specifies an offset duration to follow the cohorts over."
}
},
"type": "object"
},
"CohortsRange": {
"description": "Configures the extended reporting date range for a cohort report. Specifies an offset duration to follow the cohorts over.",
"id": "CohortsRange",
"properties": {
"endOffset": {
"description": "Required. `endOffset` specifies the end date of the extended reporting date range for a cohort report. `endOffset` can be any positive integer but is commonly set to 5 to 10 so that reports contain data on the cohort for the next several granularity time periods. If `granularity` is `DAILY`, the `endDate` of the extended reporting date range is `endDate` of the cohort plus `endOffset` days. If `granularity` is `WEEKLY`, the `endDate` of the extended reporting date range is `endDate` of the cohort plus `endOffset * 7` days. If `granularity` is `MONTHLY`, the `endDate` of the extended reporting date range is `endDate` of the cohort plus `endOffset * 30` days.",
"format": "int32",
"type": "integer"
},
"granularity": {
"description": "Required. The granularity used to interpret the `startOffset` and `endOffset` for the extended reporting date range for a cohort report.",
"enum": [
"GRANULARITY_UNSPECIFIED",
"DAILY",
"WEEKLY",
"MONTHLY"
],
"enumDescriptions": [
"Should never be specified.",
"Daily granularity. Commonly used if the cohort's `dateRange` is a single day and the request contains `cohortNthDay`.",
"Weekly granularity. Commonly used if the cohort's `dateRange` is a week in duration (starting on Sunday and ending on Saturday) and the request contains `cohortNthWeek`.",
"Monthly granularity. Commonly used if the cohort's `dateRange` is a month in duration and the request contains `cohortNthMonth`."
],
"type": "string"
},
"startOffset": {
"description": "`startOffset` specifies the start date of the extended reporting date range for a cohort report. `startOffset` is commonly set to 0 so that reports contain data from the acquisition of the cohort forward. If `granularity` is `DAILY`, the `startDate` of the extended reporting date range is `startDate` of the cohort plus `startOffset` days. If `granularity` is `WEEKLY`, the `startDate` of the extended reporting date range is `startDate` of the cohort plus `startOffset * 7` days. If `granularity` is `MONTHLY`, the `startDate` of the extended reporting date range is `startDate` of the cohort plus `startOffset * 30` days.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"ConcatenateExpression": {
"description": "Used to combine dimension values to a single dimension.",
"id": "ConcatenateExpression",
"properties": {
"delimiter": {
"description": "The delimiter placed between dimension names. Delimiters are often single characters such as \"|\" or \",\" but can be longer strings. If a dimension value contains the delimiter, both will be present in response with no distinction. For example if dimension 1 value = \"US,FR\", dimension 2 value = \"JP\", and delimiter = \",\", then the response will contain \"US,FR,JP\".",
"type": "string"
},
"dimensionNames": {
"description": "Names of dimensions. The names must refer back to names in the dimensions field of the request.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"DateRange": {
"description": "A contiguous set of days: startDate, startDate + 1, ..., endDate. Requests are allowed up to 4 date ranges.",
"id": "DateRange",
"properties": {
"endDate": {
"description": "The inclusive end date for the query in the format `YYYY-MM-DD`. Cannot be before `start_date`. The format `NdaysAgo`, `yesterday`, or `today` is also accepted, and in that case, the date is inferred based on the property's reporting time zone.",
"type": "string"
},
"name": {
"description": "Assigns a name to this date range. The dimension `dateRange` is valued to this name in a report response. If set, cannot begin with `date_range_` or `RESERVED_`. If not set, date ranges are named by their zero based index in the request: `date_range_0`, `date_range_1`, etc.",
"type": "string"
},
"startDate": {
"description": "The inclusive start date for the query in the format `YYYY-MM-DD`. Cannot be after `end_date`. The format `NdaysAgo`, `yesterday`, or `today` is also accepted, and in that case, the date is inferred based on the property's reporting time zone.",
"type": "string"
}
},
"type": "object"
},
"Dimension": {
"description": "Dimensions are attributes of your data. For example, the dimension city indicates the city from which an event originates. Dimension values in report responses are strings; for example, the city could be \"Paris\" or \"New York\". Requests are allowed up to 9 dimensions.",
"id": "Dimension",
"properties": {
"dimensionExpression": {
"$ref": "DimensionExpression",
"description": "One dimension can be the result of an expression of multiple dimensions. For example, dimension \"country, city\": concatenate(country, \", \", city)."
},
"name": {
"description": "The name of the dimension. See the [API Dimensions](https://developers.google.com/analytics/devguides/reporting/data/v1/api-schema#dimensions) for the list of dimension names. If `dimensionExpression` is specified, `name` can be any string that you would like within the allowed character set. For example if a `dimensionExpression` concatenates `country` and `city`, you could call that dimension `countryAndCity`. Dimension names that you choose must match the regular expression `^[a-zA-Z0-9_]$`. Dimensions are referenced by `name` in `dimensionFilter`, `orderBys`, `dimensionExpression`, and `pivots`.",
"type": "string"
}
},
"type": "object"
},
"DimensionCompatibility": {
"description": "The compatibility for a single dimension.",
"id": "DimensionCompatibility",
"properties": {
"compatibility": {
"description": "The compatibility of this dimension. If the compatibility is COMPATIBLE, this dimension can be successfully added to the report.",
"enum": [
"COMPATIBILITY_UNSPECIFIED",
"COMPATIBLE",
"INCOMPATIBLE"
],
"enumDescriptions": [
"Unspecified compatibility.",
"The dimension or metric is compatible. This dimension or metric can be successfully added to a report.",
"The dimension or metric is incompatible. This dimension or metric cannot be successfully added to a report."
],
"type": "string"
},
"dimensionMetadata": {
"$ref": "DimensionMetadata",
"description": "The dimension metadata contains the API name for this compatibility information. The dimension metadata also contains other helpful information like the UI name and description."
}
},
"type": "object"
},
"DimensionExpression": {
"description": "Used to express a dimension which is the result of a formula of multiple dimensions. Example usages: 1) lower_case(dimension) 2) concatenate(dimension1, symbol, dimension2).",
"id": "DimensionExpression",
"properties": {
"concatenate": {
"$ref": "ConcatenateExpression",
"description": "Used to combine dimension values to a single dimension. For example, dimension \"country, city\": concatenate(country, \", \", city)."
},
"lowerCase": {
"$ref": "CaseExpression",
"description": "Used to convert a dimension value to lower case."
},
"upperCase": {
"$ref": "CaseExpression",
"description": "Used to convert a dimension value to upper case."
}
},
"type": "object"
},
"DimensionHeader": {
"description": "Describes a dimension column in the report. Dimensions requested in a report produce column entries within rows and DimensionHeaders. However, dimensions used exclusively within filters or expressions do not produce columns in a report; correspondingly, those dimensions do not produce headers.",
"id": "DimensionHeader",
"properties": {
"name": {
"description": "The dimension's name.",
"type": "string"
}
},
"type": "object"
},
"DimensionMetadata": {
"description": "Explains a dimension.",
"id": "DimensionMetadata",
"properties": {
"apiName": {
"description": "This dimension's name. Useable in [Dimension](#Dimension)'s `name`. For example, `eventName`.",
"type": "string"
},
"category": {
"description": "The display name of the category that this dimension belongs to. Similar dimensions and metrics are categorized together.",
"type": "string"
},
"customDefinition": {
"description": "True if the dimension is a custom dimension for this property.",
"type": "boolean"
},
"deprecatedApiNames": {
"description": "Still usable but deprecated names for this dimension. If populated, this dimension is available by either `apiName` or one of `deprecatedApiNames` for a period of time. After the deprecation period, the dimension will be available only by `apiName`.",
"items": {
"type": "string"
},
"type": "array"
},
"description": {
"description": "Description of how this dimension is used and calculated.",
"type": "string"
},
"uiName": {
"description": "This dimension's name within the Google Analytics user interface. For example, `Event name`.",
"type": "string"
}
},
"type": "object"
},
"DimensionOrderBy": {
"description": "Sorts by dimension values.",
"id": "DimensionOrderBy",
"properties": {
"dimensionName": {
"description": "A dimension name in the request to order by.",
"type": "string"
},
"orderType": {
"description": "Controls the rule for dimension value ordering.",
"enum": [
"ORDER_TYPE_UNSPECIFIED",
"ALPHANUMERIC",
"CASE_INSENSITIVE_ALPHANUMERIC",
"NUMERIC"
],
"enumDescriptions": [
"Unspecified.",
"Alphanumeric sort by Unicode code point. For example, \"2\" \u003c \"A\" \u003c \"X\" \u003c \"b\" \u003c \"z\".",
"Case insensitive alphanumeric sort by lower case Unicode code point. For example, \"2\" \u003c \"A\" \u003c \"b\" \u003c \"X\" \u003c \"z\".",
"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."
],
"type": "string"
}
},
"type": "object"
},
"DimensionValue": {
"description": "The value of a dimension.",
"id": "DimensionValue",
"properties": {
"value": {
"description": "Value as a string if the dimension type is a string.",
"type": "string"
}
},
"type": "object"
},
"Filter": {
"description": "An expression to filter dimension or metric values.",
"id": "Filter",
"properties": {
"betweenFilter": {
"$ref": "BetweenFilter",
"description": "A filter for two values."
},
"fieldName": {
"description": "The dimension name or metric name. In most methods, dimensions \u0026 metrics can be used for the first time in this field. However in a RunPivotReportRequest, this field must be additionally specified by name in the RunPivotReportRequest's dimensions or metrics.",
"type": "string"
},
"inListFilter": {
"$ref": "InListFilter",
"description": "A filter for in list values."
},
"numericFilter": {
"$ref": "NumericFilter",
"description": "A filter for numeric or date values."
},
"stringFilter": {
"$ref": "StringFilter",
"description": "Strings related filter."
}
},
"type": "object"
},
"FilterExpression": {
"description": "To express dimension or metric filters. The fields in the same FilterExpression need to be either all dimensions or all metrics.",
"id": "FilterExpression",
"properties": {
"andGroup": {
"$ref": "FilterExpressionList",
"description": "The FilterExpressions in and_group have an AND relationship."
},
"filter": {
"$ref": "Filter",
"description": "A primitive filter. In the same FilterExpression, all of the filter's field names need to be either all dimensions or all metrics."
},
"notExpression": {
"$ref": "FilterExpression",
"description": "The FilterExpression is NOT of not_expression."
},
"orGroup": {
"$ref": "FilterExpressionList",
"description": "The FilterExpressions in or_group have an OR relationship."
}
},
"type": "object"
},
"FilterExpressionList": {
"description": "A list of filter expressions.",
"id": "FilterExpressionList",
"properties": {
"expressions": {
"description": "A list of filter expressions.",
"items": {
"$ref": "FilterExpression"
},
"type": "array"
}
},
"type": "object"
},
"InListFilter": {
"description": "The result needs to be in a list of string values.",
"id": "InListFilter",
"properties": {
"caseSensitive": {
"description": "If true, the string value is case sensitive.",
"type": "boolean"
},
"values": {
"description": "The list of string values. Must be non-empty.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"Metadata": {
"description": "The dimensions and metrics currently accepted in reporting methods.",
"id": "Metadata",
"properties": {
"dimensions": {
"description": "The dimension descriptions.",
"items": {
"$ref": "DimensionMetadata"
},
"type": "array"
},
"metrics": {
"description": "The metric descriptions.",
"items": {
"$ref": "MetricMetadata"
},
"type": "array"
},
"name": {
"description": "Resource name of this metadata.",
"type": "string"
}
},
"type": "object"
},
"Metric": {
"description": "The quantitative measurements of a report. For example, the metric `eventCount` is the total number of events. Requests are allowed up to 10 metrics.",
"id": "Metric",
"properties": {
"expression": {
"description": "A mathematical expression for derived metrics. For example, the metric Event count per user is `eventCount/totalUsers`.",
"type": "string"
},
"invisible": {
"description": "Indicates if a metric is invisible in the report response. If a metric is invisible, the metric will not produce a column in the response, but can be used in `metricFilter`, `orderBys`, or a metric `expression`.",
"type": "boolean"
},
"name": {
"description": "The name of the metric. See the [API Metrics](https://developers.google.com/analytics/devguides/reporting/data/v1/api-schema#metrics) for the list of metric names. If `expression` is specified, `name` can be any string that you would like within the allowed character set. For example if `expression` is `screenPageViews/sessions`, you could call that metric's name = `viewsPerSession`. Metric names that you choose must match the regular expression `^[a-zA-Z0-9_]$`. Metrics are referenced by `name` in `metricFilter`, `orderBys`, and metric `expression`.",
"type": "string"
}
},
"type": "object"
},
"MetricCompatibility": {
"description": "The compatibility for a single metric.",
"id": "MetricCompatibility",
"properties": {
"compatibility": {
"description": "The compatibility of this metric. If the compatibility is COMPATIBLE, this metric can be successfully added to the report.",
"enum": [
"COMPATIBILITY_UNSPECIFIED",
"COMPATIBLE",
"INCOMPATIBLE"
],
"enumDescriptions": [
"Unspecified compatibility.",
"The dimension or metric is compatible. This dimension or metric can be successfully added to a report.",
"The dimension or metric is incompatible. This dimension or metric cannot be successfully added to a report."
],
"type": "string"
},
"metricMetadata": {
"$ref": "MetricMetadata",
"description": "The metric metadata contains the API name for this compatibility information. The metric metadata also contains other helpful information like the UI name and description."
}
},
"type": "object"
},
"MetricHeader": {
"description": "Describes a metric column in the report. Visible metrics requested in a report produce column entries within rows and MetricHeaders. However, metrics used exclusively within filters or expressions do not produce columns in a report; correspondingly, those metrics do not produce headers.",
"id": "MetricHeader",
"properties": {
"name": {
"description": "The metric's name.",
"type": "string"
},
"type": {
"description": "The metric's data type.",
"enum": [
"METRIC_TYPE_UNSPECIFIED",
"TYPE_INTEGER",
"TYPE_FLOAT",
"TYPE_SECONDS",
"TYPE_MILLISECONDS",
"TYPE_MINUTES",
"TYPE_HOURS",
"TYPE_STANDARD",
"TYPE_CURRENCY",
"TYPE_FEET",
"TYPE_MILES",
"TYPE_METERS",
"TYPE_KILOMETERS"
],
"enumDescriptions": [
"Unspecified type.",
"Integer type.",
"Floating point type.",
"A duration of seconds; a special floating point type.",
"A duration in milliseconds; a special floating point type.",
"A duration in minutes; a special floating point type.",
"A duration in hours; a special floating point type.",
"A custom metric of standard type; a special floating point type.",
"An amount of money; a special floating point type.",
"A length in feet; a special floating point type.",
"A length in miles; a special floating point type.",
"A length in meters; a special floating point type.",
"A length in kilometers; a special floating point type."
],
"type": "string"
}
},
"type": "object"
},
"MetricMetadata": {
"description": "Explains a metric.",
"id": "MetricMetadata",
"properties": {
"apiName": {
"description": "A metric name. Useable in [Metric](#Metric)'s `name`. For example, `eventCount`.",
"type": "string"
},
"blockedReasons": {
"description": "If reasons are specified, your access is blocked to this metric for this property. API requests from you to this property for this metric will succeed; however, the report will contain only zeros for this metric. API requests with metric filters on blocked metrics will fail. If reasons are empty, you have access to this metric. To learn more, see [Access and data-restriction management](https://support.google.com/analytics/answer/10851388).",
"items": {
"enum": [
"BLOCKED_REASON_UNSPECIFIED",
"NO_REVENUE_METRICS",
"NO_COST_METRICS"
],
"enumDescriptions": [
"Will never be specified in API response.",
"If present, your access is blocked to revenue related metrics for this property, and this metric is revenue related.",
"If present, your access is blocked to cost related metrics for this property, and this metric is cost related."
],
"type": "string"
},
"type": "array"
},
"category": {
"description": "The display name of the category that this metrics belongs to. Similar dimensions and metrics are categorized together.",
"type": "string"
},
"customDefinition": {
"description": "True if the metric is a custom metric for this property.",
"type": "boolean"
},
"deprecatedApiNames": {
"description": "Still usable but deprecated names for this metric. If populated, this metric is available by either `apiName` or one of `deprecatedApiNames` for a period of time. After the deprecation period, the metric will be available only by `apiName`.",
"items": {
"type": "string"
},
"type": "array"
},