-
Notifications
You must be signed in to change notification settings - Fork 541
/
httptop.go
811 lines (694 loc) · 32.8 KB
/
httptop.go
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
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
package radar
import (
"context"
"net/http"
"net/url"
"time"
"github.com/cloudflare/cloudflare-go/v2/internal/apijson"
"github.com/cloudflare/cloudflare-go/v2/internal/apiquery"
"github.com/cloudflare/cloudflare-go/v2/internal/param"
"github.com/cloudflare/cloudflare-go/v2/internal/requestconfig"
"github.com/cloudflare/cloudflare-go/v2/option"
)
// HTTPTopService contains methods and other services that help with interacting
// with the cloudflare API. Note, unlike clients, this service does not read
// variables from the environment automatically. You should not instantiate this
// service directly, and instead use the [NewHTTPTopService] method instead.
type HTTPTopService struct {
Options []option.RequestOption
}
// NewHTTPTopService generates a new service that applies the given options to each
// request. These options are applied after the parent client's options (if there
// is one), and before any request-specific options.
func NewHTTPTopService(opts ...option.RequestOption) (r *HTTPTopService) {
r = &HTTPTopService{}
r.Options = opts
return
}
// Get the top user agents aggregated in families by HTTP traffic. Values are a
// percentage out of the total traffic.
func (r *HTTPTopService) BrowserFamilies(ctx context.Context, query HTTPTopBrowserFamiliesParams, opts ...option.RequestOption) (res *HTTPTopBrowserFamiliesResponse, err error) {
opts = append(r.Options[:], opts...)
var env HTTPTopBrowserFamiliesResponseEnvelope
path := "radar/http/top/browser_families"
err = requestconfig.ExecuteNewRequest(ctx, http.MethodGet, path, query, &env, opts...)
if err != nil {
return
}
res = &env.Result
return
}
// Get the top user agents by HTTP traffic. Values are a percentage out of the
// total traffic.
func (r *HTTPTopService) Browsers(ctx context.Context, query HTTPTopBrowsersParams, opts ...option.RequestOption) (res *HTTPTopBrowsersResponse, err error) {
opts = append(r.Options[:], opts...)
var env HTTPTopBrowsersResponseEnvelope
path := "radar/http/top/browsers"
err = requestconfig.ExecuteNewRequest(ctx, http.MethodGet, path, query, &env, opts...)
if err != nil {
return
}
res = &env.Result
return
}
type Browser struct {
Name string `json:"name,required"`
Value string `json:"value,required"`
JSON browserJSON `json:"-"`
}
// browserJSON contains the JSON metadata for the struct [Browser]
type browserJSON struct {
Name apijson.Field
Value apijson.Field
raw string
ExtraFields map[string]apijson.Field
}
func (r *Browser) UnmarshalJSON(data []byte) (err error) {
return apijson.UnmarshalRoot(data, r)
}
func (r browserJSON) RawJSON() string {
return r.raw
}
type HTTPTopBrowserFamiliesResponse struct {
Meta HTTPTopBrowserFamiliesResponseMeta `json:"meta,required"`
Top0 []Browser `json:"top_0,required"`
JSON httpTopBrowserFamiliesResponseJSON `json:"-"`
}
// httpTopBrowserFamiliesResponseJSON contains the JSON metadata for the struct
// [HTTPTopBrowserFamiliesResponse]
type httpTopBrowserFamiliesResponseJSON struct {
Meta apijson.Field
Top0 apijson.Field
raw string
ExtraFields map[string]apijson.Field
}
func (r *HTTPTopBrowserFamiliesResponse) UnmarshalJSON(data []byte) (err error) {
return apijson.UnmarshalRoot(data, r)
}
func (r httpTopBrowserFamiliesResponseJSON) RawJSON() string {
return r.raw
}
type HTTPTopBrowserFamiliesResponseMeta struct {
DateRange []HTTPTopBrowserFamiliesResponseMetaDateRange `json:"dateRange,required"`
LastUpdated string `json:"lastUpdated,required"`
ConfidenceInfo HTTPTopBrowserFamiliesResponseMetaConfidenceInfo `json:"confidenceInfo"`
JSON httpTopBrowserFamiliesResponseMetaJSON `json:"-"`
}
// httpTopBrowserFamiliesResponseMetaJSON contains the JSON metadata for the struct
// [HTTPTopBrowserFamiliesResponseMeta]
type httpTopBrowserFamiliesResponseMetaJSON struct {
DateRange apijson.Field
LastUpdated apijson.Field
ConfidenceInfo apijson.Field
raw string
ExtraFields map[string]apijson.Field
}
func (r *HTTPTopBrowserFamiliesResponseMeta) UnmarshalJSON(data []byte) (err error) {
return apijson.UnmarshalRoot(data, r)
}
func (r httpTopBrowserFamiliesResponseMetaJSON) RawJSON() string {
return r.raw
}
type HTTPTopBrowserFamiliesResponseMetaDateRange struct {
// Adjusted end of date range.
EndTime time.Time `json:"endTime,required" format:"date-time"`
// Adjusted start of date range.
StartTime time.Time `json:"startTime,required" format:"date-time"`
JSON httpTopBrowserFamiliesResponseMetaDateRangeJSON `json:"-"`
}
// httpTopBrowserFamiliesResponseMetaDateRangeJSON contains the JSON metadata for
// the struct [HTTPTopBrowserFamiliesResponseMetaDateRange]
type httpTopBrowserFamiliesResponseMetaDateRangeJSON struct {
EndTime apijson.Field
StartTime apijson.Field
raw string
ExtraFields map[string]apijson.Field
}
func (r *HTTPTopBrowserFamiliesResponseMetaDateRange) UnmarshalJSON(data []byte) (err error) {
return apijson.UnmarshalRoot(data, r)
}
func (r httpTopBrowserFamiliesResponseMetaDateRangeJSON) RawJSON() string {
return r.raw
}
type HTTPTopBrowserFamiliesResponseMetaConfidenceInfo struct {
Annotations []HTTPTopBrowserFamiliesResponseMetaConfidenceInfoAnnotation `json:"annotations"`
Level int64 `json:"level"`
JSON httpTopBrowserFamiliesResponseMetaConfidenceInfoJSON `json:"-"`
}
// httpTopBrowserFamiliesResponseMetaConfidenceInfoJSON contains the JSON metadata
// for the struct [HTTPTopBrowserFamiliesResponseMetaConfidenceInfo]
type httpTopBrowserFamiliesResponseMetaConfidenceInfoJSON struct {
Annotations apijson.Field
Level apijson.Field
raw string
ExtraFields map[string]apijson.Field
}
func (r *HTTPTopBrowserFamiliesResponseMetaConfidenceInfo) UnmarshalJSON(data []byte) (err error) {
return apijson.UnmarshalRoot(data, r)
}
func (r httpTopBrowserFamiliesResponseMetaConfidenceInfoJSON) RawJSON() string {
return r.raw
}
type HTTPTopBrowserFamiliesResponseMetaConfidenceInfoAnnotation struct {
DataSource string `json:"dataSource,required"`
Description string `json:"description,required"`
EventType string `json:"eventType,required"`
IsInstantaneous interface{} `json:"isInstantaneous,required"`
EndTime time.Time `json:"endTime" format:"date-time"`
LinkedURL string `json:"linkedUrl"`
StartTime time.Time `json:"startTime" format:"date-time"`
JSON httpTopBrowserFamiliesResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}
// httpTopBrowserFamiliesResponseMetaConfidenceInfoAnnotationJSON contains the JSON
// metadata for the struct
// [HTTPTopBrowserFamiliesResponseMetaConfidenceInfoAnnotation]
type httpTopBrowserFamiliesResponseMetaConfidenceInfoAnnotationJSON struct {
DataSource apijson.Field
Description apijson.Field
EventType apijson.Field
IsInstantaneous apijson.Field
EndTime apijson.Field
LinkedURL apijson.Field
StartTime apijson.Field
raw string
ExtraFields map[string]apijson.Field
}
func (r *HTTPTopBrowserFamiliesResponseMetaConfidenceInfoAnnotation) UnmarshalJSON(data []byte) (err error) {
return apijson.UnmarshalRoot(data, r)
}
func (r httpTopBrowserFamiliesResponseMetaConfidenceInfoAnnotationJSON) RawJSON() string {
return r.raw
}
type HTTPTopBrowsersResponse struct {
Meta HTTPTopBrowsersResponseMeta `json:"meta,required"`
Top0 []Browser `json:"top_0,required"`
JSON httpTopBrowsersResponseJSON `json:"-"`
}
// httpTopBrowsersResponseJSON contains the JSON metadata for the struct
// [HTTPTopBrowsersResponse]
type httpTopBrowsersResponseJSON struct {
Meta apijson.Field
Top0 apijson.Field
raw string
ExtraFields map[string]apijson.Field
}
func (r *HTTPTopBrowsersResponse) UnmarshalJSON(data []byte) (err error) {
return apijson.UnmarshalRoot(data, r)
}
func (r httpTopBrowsersResponseJSON) RawJSON() string {
return r.raw
}
type HTTPTopBrowsersResponseMeta struct {
DateRange []HTTPTopBrowsersResponseMetaDateRange `json:"dateRange,required"`
LastUpdated string `json:"lastUpdated,required"`
ConfidenceInfo HTTPTopBrowsersResponseMetaConfidenceInfo `json:"confidenceInfo"`
JSON httpTopBrowsersResponseMetaJSON `json:"-"`
}
// httpTopBrowsersResponseMetaJSON contains the JSON metadata for the struct
// [HTTPTopBrowsersResponseMeta]
type httpTopBrowsersResponseMetaJSON struct {
DateRange apijson.Field
LastUpdated apijson.Field
ConfidenceInfo apijson.Field
raw string
ExtraFields map[string]apijson.Field
}
func (r *HTTPTopBrowsersResponseMeta) UnmarshalJSON(data []byte) (err error) {
return apijson.UnmarshalRoot(data, r)
}
func (r httpTopBrowsersResponseMetaJSON) RawJSON() string {
return r.raw
}
type HTTPTopBrowsersResponseMetaDateRange struct {
// Adjusted end of date range.
EndTime time.Time `json:"endTime,required" format:"date-time"`
// Adjusted start of date range.
StartTime time.Time `json:"startTime,required" format:"date-time"`
JSON httpTopBrowsersResponseMetaDateRangeJSON `json:"-"`
}
// httpTopBrowsersResponseMetaDateRangeJSON contains the JSON metadata for the
// struct [HTTPTopBrowsersResponseMetaDateRange]
type httpTopBrowsersResponseMetaDateRangeJSON struct {
EndTime apijson.Field
StartTime apijson.Field
raw string
ExtraFields map[string]apijson.Field
}
func (r *HTTPTopBrowsersResponseMetaDateRange) UnmarshalJSON(data []byte) (err error) {
return apijson.UnmarshalRoot(data, r)
}
func (r httpTopBrowsersResponseMetaDateRangeJSON) RawJSON() string {
return r.raw
}
type HTTPTopBrowsersResponseMetaConfidenceInfo struct {
Annotations []HTTPTopBrowsersResponseMetaConfidenceInfoAnnotation `json:"annotations"`
Level int64 `json:"level"`
JSON httpTopBrowsersResponseMetaConfidenceInfoJSON `json:"-"`
}
// httpTopBrowsersResponseMetaConfidenceInfoJSON contains the JSON metadata for the
// struct [HTTPTopBrowsersResponseMetaConfidenceInfo]
type httpTopBrowsersResponseMetaConfidenceInfoJSON struct {
Annotations apijson.Field
Level apijson.Field
raw string
ExtraFields map[string]apijson.Field
}
func (r *HTTPTopBrowsersResponseMetaConfidenceInfo) UnmarshalJSON(data []byte) (err error) {
return apijson.UnmarshalRoot(data, r)
}
func (r httpTopBrowsersResponseMetaConfidenceInfoJSON) RawJSON() string {
return r.raw
}
type HTTPTopBrowsersResponseMetaConfidenceInfoAnnotation struct {
DataSource string `json:"dataSource,required"`
Description string `json:"description,required"`
EventType string `json:"eventType,required"`
IsInstantaneous interface{} `json:"isInstantaneous,required"`
EndTime time.Time `json:"endTime" format:"date-time"`
LinkedURL string `json:"linkedUrl"`
StartTime time.Time `json:"startTime" format:"date-time"`
JSON httpTopBrowsersResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}
// httpTopBrowsersResponseMetaConfidenceInfoAnnotationJSON contains the JSON
// metadata for the struct [HTTPTopBrowsersResponseMetaConfidenceInfoAnnotation]
type httpTopBrowsersResponseMetaConfidenceInfoAnnotationJSON struct {
DataSource apijson.Field
Description apijson.Field
EventType apijson.Field
IsInstantaneous apijson.Field
EndTime apijson.Field
LinkedURL apijson.Field
StartTime apijson.Field
raw string
ExtraFields map[string]apijson.Field
}
func (r *HTTPTopBrowsersResponseMetaConfidenceInfoAnnotation) UnmarshalJSON(data []byte) (err error) {
return apijson.UnmarshalRoot(data, r)
}
func (r httpTopBrowsersResponseMetaConfidenceInfoAnnotationJSON) RawJSON() string {
return r.raw
}
type HTTPTopBrowserFamiliesParams struct {
// Array of comma separated list of ASNs, start with `-` to exclude from results.
// For example, `-174, 3356` excludes results from AS174, but includes results from
// AS3356.
ASN param.Field[[]string] `query:"asn"`
// Filter for bot class. Refer to
// [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).
BotClass param.Field[[]HTTPTopBrowserFamiliesParamsBotClass] `query:"botClass"`
// Array of comma separated list of continents (alpha-2 continent codes). Start
// with `-` to exclude from results. For example, `-EU,NA` excludes results from
// Europe, but includes results from North America.
Continent param.Field[[]string] `query:"continent"`
// End of the date range (inclusive).
DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
// For example, use `7d` and `7dControl` to compare this week with the previous
// week. Use this parameter or set specific start and end dates (`dateStart` and
// `dateEnd` parameters).
DateRange param.Field[[]HTTPTopBrowserFamiliesParamsDateRange] `query:"dateRange"`
// Array of datetimes to filter the start of a series.
DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
// Filter for device type.
DeviceType param.Field[[]HTTPTopBrowserFamiliesParamsDeviceType] `query:"deviceType"`
// Format results are returned in.
Format param.Field[HTTPTopBrowserFamiliesParamsFormat] `query:"format"`
// Filter for http protocol.
HTTPProtocol param.Field[[]HTTPTopBrowserFamiliesParamsHTTPProtocol] `query:"httpProtocol"`
// Filter for http version.
HTTPVersion param.Field[[]HTTPTopBrowserFamiliesParamsHTTPVersion] `query:"httpVersion"`
// Filter for ip version.
IPVersion param.Field[[]HTTPTopBrowserFamiliesParamsIPVersion] `query:"ipVersion"`
// Limit the number of objects in the response.
Limit param.Field[int64] `query:"limit"`
// Array of comma separated list of locations (alpha-2 country codes). Start with
// `-` to exclude from results. For example, `-US,PT` excludes results from the US,
// but includes results from PT.
Location param.Field[[]string] `query:"location"`
// Array of names that will be used to name the series in responses.
Name param.Field[[]string] `query:"name"`
// Filter for os name.
OS param.Field[[]HTTPTopBrowserFamiliesParamsOS] `query:"os"`
// Filter for tls version.
TLSVersion param.Field[[]HTTPTopBrowserFamiliesParamsTLSVersion] `query:"tlsVersion"`
}
// URLQuery serializes [HTTPTopBrowserFamiliesParams]'s query parameters as
// `url.Values`.
func (r HTTPTopBrowserFamiliesParams) URLQuery() (v url.Values) {
return apiquery.MarshalWithSettings(r, apiquery.QuerySettings{
ArrayFormat: apiquery.ArrayQueryFormatRepeat,
NestedFormat: apiquery.NestedQueryFormatBrackets,
})
}
type HTTPTopBrowserFamiliesParamsBotClass string
const (
HTTPTopBrowserFamiliesParamsBotClassLikelyAutomated HTTPTopBrowserFamiliesParamsBotClass = "LIKELY_AUTOMATED"
HTTPTopBrowserFamiliesParamsBotClassLikelyHuman HTTPTopBrowserFamiliesParamsBotClass = "LIKELY_HUMAN"
)
func (r HTTPTopBrowserFamiliesParamsBotClass) IsKnown() bool {
switch r {
case HTTPTopBrowserFamiliesParamsBotClassLikelyAutomated, HTTPTopBrowserFamiliesParamsBotClassLikelyHuman:
return true
}
return false
}
type HTTPTopBrowserFamiliesParamsDateRange string
const (
HTTPTopBrowserFamiliesParamsDateRange1d HTTPTopBrowserFamiliesParamsDateRange = "1d"
HTTPTopBrowserFamiliesParamsDateRange2d HTTPTopBrowserFamiliesParamsDateRange = "2d"
HTTPTopBrowserFamiliesParamsDateRange7d HTTPTopBrowserFamiliesParamsDateRange = "7d"
HTTPTopBrowserFamiliesParamsDateRange14d HTTPTopBrowserFamiliesParamsDateRange = "14d"
HTTPTopBrowserFamiliesParamsDateRange28d HTTPTopBrowserFamiliesParamsDateRange = "28d"
HTTPTopBrowserFamiliesParamsDateRange12w HTTPTopBrowserFamiliesParamsDateRange = "12w"
HTTPTopBrowserFamiliesParamsDateRange24w HTTPTopBrowserFamiliesParamsDateRange = "24w"
HTTPTopBrowserFamiliesParamsDateRange52w HTTPTopBrowserFamiliesParamsDateRange = "52w"
HTTPTopBrowserFamiliesParamsDateRange1dControl HTTPTopBrowserFamiliesParamsDateRange = "1dControl"
HTTPTopBrowserFamiliesParamsDateRange2dControl HTTPTopBrowserFamiliesParamsDateRange = "2dControl"
HTTPTopBrowserFamiliesParamsDateRange7dControl HTTPTopBrowserFamiliesParamsDateRange = "7dControl"
HTTPTopBrowserFamiliesParamsDateRange14dControl HTTPTopBrowserFamiliesParamsDateRange = "14dControl"
HTTPTopBrowserFamiliesParamsDateRange28dControl HTTPTopBrowserFamiliesParamsDateRange = "28dControl"
HTTPTopBrowserFamiliesParamsDateRange12wControl HTTPTopBrowserFamiliesParamsDateRange = "12wControl"
HTTPTopBrowserFamiliesParamsDateRange24wControl HTTPTopBrowserFamiliesParamsDateRange = "24wControl"
)
func (r HTTPTopBrowserFamiliesParamsDateRange) IsKnown() bool {
switch r {
case HTTPTopBrowserFamiliesParamsDateRange1d, HTTPTopBrowserFamiliesParamsDateRange2d, HTTPTopBrowserFamiliesParamsDateRange7d, HTTPTopBrowserFamiliesParamsDateRange14d, HTTPTopBrowserFamiliesParamsDateRange28d, HTTPTopBrowserFamiliesParamsDateRange12w, HTTPTopBrowserFamiliesParamsDateRange24w, HTTPTopBrowserFamiliesParamsDateRange52w, HTTPTopBrowserFamiliesParamsDateRange1dControl, HTTPTopBrowserFamiliesParamsDateRange2dControl, HTTPTopBrowserFamiliesParamsDateRange7dControl, HTTPTopBrowserFamiliesParamsDateRange14dControl, HTTPTopBrowserFamiliesParamsDateRange28dControl, HTTPTopBrowserFamiliesParamsDateRange12wControl, HTTPTopBrowserFamiliesParamsDateRange24wControl:
return true
}
return false
}
type HTTPTopBrowserFamiliesParamsDeviceType string
const (
HTTPTopBrowserFamiliesParamsDeviceTypeDesktop HTTPTopBrowserFamiliesParamsDeviceType = "DESKTOP"
HTTPTopBrowserFamiliesParamsDeviceTypeMobile HTTPTopBrowserFamiliesParamsDeviceType = "MOBILE"
HTTPTopBrowserFamiliesParamsDeviceTypeOther HTTPTopBrowserFamiliesParamsDeviceType = "OTHER"
)
func (r HTTPTopBrowserFamiliesParamsDeviceType) IsKnown() bool {
switch r {
case HTTPTopBrowserFamiliesParamsDeviceTypeDesktop, HTTPTopBrowserFamiliesParamsDeviceTypeMobile, HTTPTopBrowserFamiliesParamsDeviceTypeOther:
return true
}
return false
}
// Format results are returned in.
type HTTPTopBrowserFamiliesParamsFormat string
const (
HTTPTopBrowserFamiliesParamsFormatJson HTTPTopBrowserFamiliesParamsFormat = "JSON"
HTTPTopBrowserFamiliesParamsFormatCsv HTTPTopBrowserFamiliesParamsFormat = "CSV"
)
func (r HTTPTopBrowserFamiliesParamsFormat) IsKnown() bool {
switch r {
case HTTPTopBrowserFamiliesParamsFormatJson, HTTPTopBrowserFamiliesParamsFormatCsv:
return true
}
return false
}
type HTTPTopBrowserFamiliesParamsHTTPProtocol string
const (
HTTPTopBrowserFamiliesParamsHTTPProtocolHTTP HTTPTopBrowserFamiliesParamsHTTPProtocol = "HTTP"
HTTPTopBrowserFamiliesParamsHTTPProtocolHTTPS HTTPTopBrowserFamiliesParamsHTTPProtocol = "HTTPS"
)
func (r HTTPTopBrowserFamiliesParamsHTTPProtocol) IsKnown() bool {
switch r {
case HTTPTopBrowserFamiliesParamsHTTPProtocolHTTP, HTTPTopBrowserFamiliesParamsHTTPProtocolHTTPS:
return true
}
return false
}
type HTTPTopBrowserFamiliesParamsHTTPVersion string
const (
HTTPTopBrowserFamiliesParamsHTTPVersionHttPv1 HTTPTopBrowserFamiliesParamsHTTPVersion = "HTTPv1"
HTTPTopBrowserFamiliesParamsHTTPVersionHttPv2 HTTPTopBrowserFamiliesParamsHTTPVersion = "HTTPv2"
HTTPTopBrowserFamiliesParamsHTTPVersionHttPv3 HTTPTopBrowserFamiliesParamsHTTPVersion = "HTTPv3"
)
func (r HTTPTopBrowserFamiliesParamsHTTPVersion) IsKnown() bool {
switch r {
case HTTPTopBrowserFamiliesParamsHTTPVersionHttPv1, HTTPTopBrowserFamiliesParamsHTTPVersionHttPv2, HTTPTopBrowserFamiliesParamsHTTPVersionHttPv3:
return true
}
return false
}
type HTTPTopBrowserFamiliesParamsIPVersion string
const (
HTTPTopBrowserFamiliesParamsIPVersionIPv4 HTTPTopBrowserFamiliesParamsIPVersion = "IPv4"
HTTPTopBrowserFamiliesParamsIPVersionIPv6 HTTPTopBrowserFamiliesParamsIPVersion = "IPv6"
)
func (r HTTPTopBrowserFamiliesParamsIPVersion) IsKnown() bool {
switch r {
case HTTPTopBrowserFamiliesParamsIPVersionIPv4, HTTPTopBrowserFamiliesParamsIPVersionIPv6:
return true
}
return false
}
type HTTPTopBrowserFamiliesParamsOS string
const (
HTTPTopBrowserFamiliesParamsOSWindows HTTPTopBrowserFamiliesParamsOS = "WINDOWS"
HTTPTopBrowserFamiliesParamsOSMacosx HTTPTopBrowserFamiliesParamsOS = "MACOSX"
HTTPTopBrowserFamiliesParamsOSIos HTTPTopBrowserFamiliesParamsOS = "IOS"
HTTPTopBrowserFamiliesParamsOSAndroid HTTPTopBrowserFamiliesParamsOS = "ANDROID"
HTTPTopBrowserFamiliesParamsOSChromeos HTTPTopBrowserFamiliesParamsOS = "CHROMEOS"
HTTPTopBrowserFamiliesParamsOSLinux HTTPTopBrowserFamiliesParamsOS = "LINUX"
HTTPTopBrowserFamiliesParamsOSSmartTv HTTPTopBrowserFamiliesParamsOS = "SMART_TV"
)
func (r HTTPTopBrowserFamiliesParamsOS) IsKnown() bool {
switch r {
case HTTPTopBrowserFamiliesParamsOSWindows, HTTPTopBrowserFamiliesParamsOSMacosx, HTTPTopBrowserFamiliesParamsOSIos, HTTPTopBrowserFamiliesParamsOSAndroid, HTTPTopBrowserFamiliesParamsOSChromeos, HTTPTopBrowserFamiliesParamsOSLinux, HTTPTopBrowserFamiliesParamsOSSmartTv:
return true
}
return false
}
type HTTPTopBrowserFamiliesParamsTLSVersion string
const (
HTTPTopBrowserFamiliesParamsTLSVersionTlSv1_0 HTTPTopBrowserFamiliesParamsTLSVersion = "TLSv1_0"
HTTPTopBrowserFamiliesParamsTLSVersionTlSv1_1 HTTPTopBrowserFamiliesParamsTLSVersion = "TLSv1_1"
HTTPTopBrowserFamiliesParamsTLSVersionTlSv1_2 HTTPTopBrowserFamiliesParamsTLSVersion = "TLSv1_2"
HTTPTopBrowserFamiliesParamsTLSVersionTlSv1_3 HTTPTopBrowserFamiliesParamsTLSVersion = "TLSv1_3"
HTTPTopBrowserFamiliesParamsTLSVersionTlSvQuic HTTPTopBrowserFamiliesParamsTLSVersion = "TLSvQUIC"
)
func (r HTTPTopBrowserFamiliesParamsTLSVersion) IsKnown() bool {
switch r {
case HTTPTopBrowserFamiliesParamsTLSVersionTlSv1_0, HTTPTopBrowserFamiliesParamsTLSVersionTlSv1_1, HTTPTopBrowserFamiliesParamsTLSVersionTlSv1_2, HTTPTopBrowserFamiliesParamsTLSVersionTlSv1_3, HTTPTopBrowserFamiliesParamsTLSVersionTlSvQuic:
return true
}
return false
}
type HTTPTopBrowserFamiliesResponseEnvelope struct {
Result HTTPTopBrowserFamiliesResponse `json:"result,required"`
Success bool `json:"success,required"`
JSON httpTopBrowserFamiliesResponseEnvelopeJSON `json:"-"`
}
// httpTopBrowserFamiliesResponseEnvelopeJSON contains the JSON metadata for the
// struct [HTTPTopBrowserFamiliesResponseEnvelope]
type httpTopBrowserFamiliesResponseEnvelopeJSON struct {
Result apijson.Field
Success apijson.Field
raw string
ExtraFields map[string]apijson.Field
}
func (r *HTTPTopBrowserFamiliesResponseEnvelope) UnmarshalJSON(data []byte) (err error) {
return apijson.UnmarshalRoot(data, r)
}
func (r httpTopBrowserFamiliesResponseEnvelopeJSON) RawJSON() string {
return r.raw
}
type HTTPTopBrowsersParams struct {
// Array of comma separated list of ASNs, start with `-` to exclude from results.
// For example, `-174, 3356` excludes results from AS174, but includes results from
// AS3356.
ASN param.Field[[]string] `query:"asn"`
// Filter for bot class. Refer to
// [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).
BotClass param.Field[[]HTTPTopBrowsersParamsBotClass] `query:"botClass"`
// Array of comma separated list of continents (alpha-2 continent codes). Start
// with `-` to exclude from results. For example, `-EU,NA` excludes results from
// Europe, but includes results from North America.
Continent param.Field[[]string] `query:"continent"`
// End of the date range (inclusive).
DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
// For example, use `7d` and `7dControl` to compare this week with the previous
// week. Use this parameter or set specific start and end dates (`dateStart` and
// `dateEnd` parameters).
DateRange param.Field[[]HTTPTopBrowsersParamsDateRange] `query:"dateRange"`
// Array of datetimes to filter the start of a series.
DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
// Filter for device type.
DeviceType param.Field[[]HTTPTopBrowsersParamsDeviceType] `query:"deviceType"`
// Format results are returned in.
Format param.Field[HTTPTopBrowsersParamsFormat] `query:"format"`
// Filter for http protocol.
HTTPProtocol param.Field[[]HTTPTopBrowsersParamsHTTPProtocol] `query:"httpProtocol"`
// Filter for http version.
HTTPVersion param.Field[[]HTTPTopBrowsersParamsHTTPVersion] `query:"httpVersion"`
// Filter for ip version.
IPVersion param.Field[[]HTTPTopBrowsersParamsIPVersion] `query:"ipVersion"`
// Limit the number of objects in the response.
Limit param.Field[int64] `query:"limit"`
// Array of comma separated list of locations (alpha-2 country codes). Start with
// `-` to exclude from results. For example, `-US,PT` excludes results from the US,
// but includes results from PT.
Location param.Field[[]string] `query:"location"`
// Array of names that will be used to name the series in responses.
Name param.Field[[]string] `query:"name"`
// Filter for os name.
OS param.Field[[]HTTPTopBrowsersParamsOS] `query:"os"`
// Filter for tls version.
TLSVersion param.Field[[]HTTPTopBrowsersParamsTLSVersion] `query:"tlsVersion"`
}
// URLQuery serializes [HTTPTopBrowsersParams]'s query parameters as `url.Values`.
func (r HTTPTopBrowsersParams) URLQuery() (v url.Values) {
return apiquery.MarshalWithSettings(r, apiquery.QuerySettings{
ArrayFormat: apiquery.ArrayQueryFormatRepeat,
NestedFormat: apiquery.NestedQueryFormatBrackets,
})
}
type HTTPTopBrowsersParamsBotClass string
const (
HTTPTopBrowsersParamsBotClassLikelyAutomated HTTPTopBrowsersParamsBotClass = "LIKELY_AUTOMATED"
HTTPTopBrowsersParamsBotClassLikelyHuman HTTPTopBrowsersParamsBotClass = "LIKELY_HUMAN"
)
func (r HTTPTopBrowsersParamsBotClass) IsKnown() bool {
switch r {
case HTTPTopBrowsersParamsBotClassLikelyAutomated, HTTPTopBrowsersParamsBotClassLikelyHuman:
return true
}
return false
}
type HTTPTopBrowsersParamsDateRange string
const (
HTTPTopBrowsersParamsDateRange1d HTTPTopBrowsersParamsDateRange = "1d"
HTTPTopBrowsersParamsDateRange2d HTTPTopBrowsersParamsDateRange = "2d"
HTTPTopBrowsersParamsDateRange7d HTTPTopBrowsersParamsDateRange = "7d"
HTTPTopBrowsersParamsDateRange14d HTTPTopBrowsersParamsDateRange = "14d"
HTTPTopBrowsersParamsDateRange28d HTTPTopBrowsersParamsDateRange = "28d"
HTTPTopBrowsersParamsDateRange12w HTTPTopBrowsersParamsDateRange = "12w"
HTTPTopBrowsersParamsDateRange24w HTTPTopBrowsersParamsDateRange = "24w"
HTTPTopBrowsersParamsDateRange52w HTTPTopBrowsersParamsDateRange = "52w"
HTTPTopBrowsersParamsDateRange1dControl HTTPTopBrowsersParamsDateRange = "1dControl"
HTTPTopBrowsersParamsDateRange2dControl HTTPTopBrowsersParamsDateRange = "2dControl"
HTTPTopBrowsersParamsDateRange7dControl HTTPTopBrowsersParamsDateRange = "7dControl"
HTTPTopBrowsersParamsDateRange14dControl HTTPTopBrowsersParamsDateRange = "14dControl"
HTTPTopBrowsersParamsDateRange28dControl HTTPTopBrowsersParamsDateRange = "28dControl"
HTTPTopBrowsersParamsDateRange12wControl HTTPTopBrowsersParamsDateRange = "12wControl"
HTTPTopBrowsersParamsDateRange24wControl HTTPTopBrowsersParamsDateRange = "24wControl"
)
func (r HTTPTopBrowsersParamsDateRange) IsKnown() bool {
switch r {
case HTTPTopBrowsersParamsDateRange1d, HTTPTopBrowsersParamsDateRange2d, HTTPTopBrowsersParamsDateRange7d, HTTPTopBrowsersParamsDateRange14d, HTTPTopBrowsersParamsDateRange28d, HTTPTopBrowsersParamsDateRange12w, HTTPTopBrowsersParamsDateRange24w, HTTPTopBrowsersParamsDateRange52w, HTTPTopBrowsersParamsDateRange1dControl, HTTPTopBrowsersParamsDateRange2dControl, HTTPTopBrowsersParamsDateRange7dControl, HTTPTopBrowsersParamsDateRange14dControl, HTTPTopBrowsersParamsDateRange28dControl, HTTPTopBrowsersParamsDateRange12wControl, HTTPTopBrowsersParamsDateRange24wControl:
return true
}
return false
}
type HTTPTopBrowsersParamsDeviceType string
const (
HTTPTopBrowsersParamsDeviceTypeDesktop HTTPTopBrowsersParamsDeviceType = "DESKTOP"
HTTPTopBrowsersParamsDeviceTypeMobile HTTPTopBrowsersParamsDeviceType = "MOBILE"
HTTPTopBrowsersParamsDeviceTypeOther HTTPTopBrowsersParamsDeviceType = "OTHER"
)
func (r HTTPTopBrowsersParamsDeviceType) IsKnown() bool {
switch r {
case HTTPTopBrowsersParamsDeviceTypeDesktop, HTTPTopBrowsersParamsDeviceTypeMobile, HTTPTopBrowsersParamsDeviceTypeOther:
return true
}
return false
}
// Format results are returned in.
type HTTPTopBrowsersParamsFormat string
const (
HTTPTopBrowsersParamsFormatJson HTTPTopBrowsersParamsFormat = "JSON"
HTTPTopBrowsersParamsFormatCsv HTTPTopBrowsersParamsFormat = "CSV"
)
func (r HTTPTopBrowsersParamsFormat) IsKnown() bool {
switch r {
case HTTPTopBrowsersParamsFormatJson, HTTPTopBrowsersParamsFormatCsv:
return true
}
return false
}
type HTTPTopBrowsersParamsHTTPProtocol string
const (
HTTPTopBrowsersParamsHTTPProtocolHTTP HTTPTopBrowsersParamsHTTPProtocol = "HTTP"
HTTPTopBrowsersParamsHTTPProtocolHTTPS HTTPTopBrowsersParamsHTTPProtocol = "HTTPS"
)
func (r HTTPTopBrowsersParamsHTTPProtocol) IsKnown() bool {
switch r {
case HTTPTopBrowsersParamsHTTPProtocolHTTP, HTTPTopBrowsersParamsHTTPProtocolHTTPS:
return true
}
return false
}
type HTTPTopBrowsersParamsHTTPVersion string
const (
HTTPTopBrowsersParamsHTTPVersionHttPv1 HTTPTopBrowsersParamsHTTPVersion = "HTTPv1"
HTTPTopBrowsersParamsHTTPVersionHttPv2 HTTPTopBrowsersParamsHTTPVersion = "HTTPv2"
HTTPTopBrowsersParamsHTTPVersionHttPv3 HTTPTopBrowsersParamsHTTPVersion = "HTTPv3"
)
func (r HTTPTopBrowsersParamsHTTPVersion) IsKnown() bool {
switch r {
case HTTPTopBrowsersParamsHTTPVersionHttPv1, HTTPTopBrowsersParamsHTTPVersionHttPv2, HTTPTopBrowsersParamsHTTPVersionHttPv3:
return true
}
return false
}
type HTTPTopBrowsersParamsIPVersion string
const (
HTTPTopBrowsersParamsIPVersionIPv4 HTTPTopBrowsersParamsIPVersion = "IPv4"
HTTPTopBrowsersParamsIPVersionIPv6 HTTPTopBrowsersParamsIPVersion = "IPv6"
)
func (r HTTPTopBrowsersParamsIPVersion) IsKnown() bool {
switch r {
case HTTPTopBrowsersParamsIPVersionIPv4, HTTPTopBrowsersParamsIPVersionIPv6:
return true
}
return false
}
type HTTPTopBrowsersParamsOS string
const (
HTTPTopBrowsersParamsOSWindows HTTPTopBrowsersParamsOS = "WINDOWS"
HTTPTopBrowsersParamsOSMacosx HTTPTopBrowsersParamsOS = "MACOSX"
HTTPTopBrowsersParamsOSIos HTTPTopBrowsersParamsOS = "IOS"
HTTPTopBrowsersParamsOSAndroid HTTPTopBrowsersParamsOS = "ANDROID"
HTTPTopBrowsersParamsOSChromeos HTTPTopBrowsersParamsOS = "CHROMEOS"
HTTPTopBrowsersParamsOSLinux HTTPTopBrowsersParamsOS = "LINUX"
HTTPTopBrowsersParamsOSSmartTv HTTPTopBrowsersParamsOS = "SMART_TV"
)
func (r HTTPTopBrowsersParamsOS) IsKnown() bool {
switch r {
case HTTPTopBrowsersParamsOSWindows, HTTPTopBrowsersParamsOSMacosx, HTTPTopBrowsersParamsOSIos, HTTPTopBrowsersParamsOSAndroid, HTTPTopBrowsersParamsOSChromeos, HTTPTopBrowsersParamsOSLinux, HTTPTopBrowsersParamsOSSmartTv:
return true
}
return false
}
type HTTPTopBrowsersParamsTLSVersion string
const (
HTTPTopBrowsersParamsTLSVersionTlSv1_0 HTTPTopBrowsersParamsTLSVersion = "TLSv1_0"
HTTPTopBrowsersParamsTLSVersionTlSv1_1 HTTPTopBrowsersParamsTLSVersion = "TLSv1_1"
HTTPTopBrowsersParamsTLSVersionTlSv1_2 HTTPTopBrowsersParamsTLSVersion = "TLSv1_2"
HTTPTopBrowsersParamsTLSVersionTlSv1_3 HTTPTopBrowsersParamsTLSVersion = "TLSv1_3"
HTTPTopBrowsersParamsTLSVersionTlSvQuic HTTPTopBrowsersParamsTLSVersion = "TLSvQUIC"
)
func (r HTTPTopBrowsersParamsTLSVersion) IsKnown() bool {
switch r {
case HTTPTopBrowsersParamsTLSVersionTlSv1_0, HTTPTopBrowsersParamsTLSVersionTlSv1_1, HTTPTopBrowsersParamsTLSVersionTlSv1_2, HTTPTopBrowsersParamsTLSVersionTlSv1_3, HTTPTopBrowsersParamsTLSVersionTlSvQuic:
return true
}
return false
}
type HTTPTopBrowsersResponseEnvelope struct {
Result HTTPTopBrowsersResponse `json:"result,required"`
Success bool `json:"success,required"`
JSON httpTopBrowsersResponseEnvelopeJSON `json:"-"`
}
// httpTopBrowsersResponseEnvelopeJSON contains the JSON metadata for the struct
// [HTTPTopBrowsersResponseEnvelope]
type httpTopBrowsersResponseEnvelopeJSON struct {
Result apijson.Field
Success apijson.Field
raw string
ExtraFields map[string]apijson.Field
}
func (r *HTTPTopBrowsersResponseEnvelope) UnmarshalJSON(data []byte) (err error) {
return apijson.UnmarshalRoot(data, r)
}
func (r httpTopBrowsersResponseEnvelopeJSON) RawJSON() string {
return r.raw
}