-
Notifications
You must be signed in to change notification settings - Fork 3
Expand file tree
/
Copy pathopenapi.yaml
More file actions
2468 lines (2345 loc) · 78.5 KB
/
openapi.yaml
File metadata and controls
2468 lines (2345 loc) · 78.5 KB
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
openapi: 3.0.3
info:
title: LogLynx API
description: |
LogLynx is an advanced log analytics platform for analyzing Traefik access logs and other log sources.
This API provides comprehensive statistics, real-time metrics, and detailed insights into your web traffic.
## Features
- **Summary Statistics**: Get overall metrics including requests, visitors, bandwidth, and response times
- **Timeline Data**: Analyze traffic patterns over time with customizable time ranges
- **Top Statistics**: Identify top paths, countries, IPs, user agents, and more
- **Distribution Analytics**: View distributions of status codes, HTTP methods, protocols, and device types
- **Real-time Monitoring**: Stream live metrics via Server-Sent Events (SSE)
- **Performance Metrics**: Track response times and backend health
- **Geographic Analytics**: Analyze traffic by country and region
- **IP Analytics**: Deep-dive analytics for specific IP addresses
- **Service Filtering**: Filter by backend name, URL, or host with intelligent auto-detection
## Service Filtering
Most endpoints support service-based filtering with the following parameters:
### Single Service Filtering
- `service`: Service name to filter by (e.g., "api-service", "web-frontend")
- `service_type`: Type of service identifier
- `auto` (default): Automatically detects and uses backend_name, backend_url, or host
- `backend_name`: Filter by Traefik backend name
- `backend_url`: Filter by backend URL
- `host`: Filter by HTTP Host header
- `host`: Legacy parameter (backward compatible), equivalent to `service` with `service_type=auto`
### Multi-Service Filtering (Array Parameters)
For filtering across multiple services simultaneously, use array parameters:
- `services[]`: Array of service names (can be repeated)
- `service_types[]`: Corresponding array of service types (must match length of services[])
**Example**: Filter for two services
```
/api/v1/stats/summary?services[]=api-service&service_types[]=backend_name&services[]=web-app&service_types[]=host
```
## Hide My Traffic
Endpoints that return request data support excluding your own IP address:
- `exclude_own_ip`: Set to `true` to exclude requests from your IP (boolean)
- `exclude_services[]`: Optional array of service names to exclude your IP from (if omitted, excludes from all services)
- `exclude_service_types[]`: Corresponding array of service types for exclude_services[]
**Example**: Hide my traffic only on specific services
```
/api/v1/requests/recent?exclude_own_ip=true&exclude_services[]=admin-panel&exclude_service_types[]=backend_name
```
## Common Query Parameters
- `limit`: Maximum number of results (varies by endpoint, typically 1-100)
- `offset`: Pagination offset for results
- `hours`: Time range in hours (1-8760, default varies by endpoint)
- `days`: Time range in days (1-365, default varies by endpoint)
version: 1.0.3
contact:
name: LogLynx Support
url: https://github.com/k0lin/loglynx
license:
name: MIT
url: https://opensource.org/licenses/MIT
servers:
- url: http://localhost:8080/api/v1
description: Local development server
tags:
- name: Summary
description: Overall statistics and summary data
- name: Timeline
description: Time-series data and trends
- name: Top Statistics
description: Top items by various metrics
- name: Distributions
description: Distribution of categorical data
- name: Performance
description: Response time and performance metrics
- name: Real-time
description: Live metrics and streaming data
- name: Requests
description: Individual request data
- name: System
description: System information and log processing stats
- name: IP Analytics
description: IP-specific statistics and analytics
- name: Widget
description: Compact widget endpoints for iframe embedding
paths:
/stats/summary:
get:
tags:
- Summary
summary: Get summary statistics
description: |
Returns overall statistics including total requests, unique visitors, bandwidth, success rates, and top items.
**Service Filtering**: Use `service` and `service_type` for single service filtering, or `services[]` and `service_types[]` for multi-service filtering.
Legacy `host` parameter is supported for backward compatibility.
**Hide My Traffic**: Use `exclude_own_ip=true` to exclude your IP from results.
operationId: getSummary
parameters:
- $ref: '#/components/parameters/ServiceFilter'
- $ref: '#/components/parameters/ServiceTypeFilter'
- $ref: '#/components/parameters/ServicesArray'
- $ref: '#/components/parameters/ServiceTypesArray'
- $ref: '#/components/parameters/HostFilter'
- $ref: '#/components/parameters/HoursParam'
- $ref: '#/components/parameters/ExcludeOwnIP'
- $ref: '#/components/parameters/ExcludeServices'
- $ref: '#/components/parameters/ExcludeServiceTypes'
responses:
'200':
description: Summary statistics
content:
application/json:
schema:
$ref: '#/components/schemas/StatsSummary'
'500':
$ref: '#/components/responses/InternalServerError'
/stats/timeline:
get:
tags:
- Timeline
summary: Get timeline statistics
description: |
Returns time-series data for requests, visitors, bandwidth, and response times.
Supports service filtering and hide my traffic functionality.
operationId: getTimeline
parameters:
- $ref: '#/components/parameters/ServiceFilter'
- $ref: '#/components/parameters/ServiceTypeFilter'
- $ref: '#/components/parameters/ServicesArray'
- $ref: '#/components/parameters/ServiceTypesArray'
- $ref: '#/components/parameters/HostFilter'
- $ref: '#/components/parameters/HoursParam'
- $ref: '#/components/parameters/ExcludeOwnIP'
- $ref: '#/components/parameters/ExcludeServices'
- $ref: '#/components/parameters/ExcludeServiceTypes'
responses:
'200':
description: Timeline data
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/TimelineData'
'500':
$ref: '#/components/responses/InternalServerError'
/stats/timeline/status-codes:
get:
tags:
- Timeline
summary: Get status code timeline
description: |
Returns status code distribution over time for stacked area charts.
Supports service filtering and hide my traffic functionality.
operationId: getStatusCodeTimeline
parameters:
- $ref: '#/components/parameters/ServiceFilter'
- $ref: '#/components/parameters/ServiceTypeFilter'
- $ref: '#/components/parameters/ServicesArray'
- $ref: '#/components/parameters/ServiceTypesArray'
- $ref: '#/components/parameters/HostFilter'
- $ref: '#/components/parameters/HoursParam'
- $ref: '#/components/parameters/ExcludeOwnIP'
- $ref: '#/components/parameters/ExcludeServices'
- $ref: '#/components/parameters/ExcludeServiceTypes'
responses:
'200':
description: Status code timeline data
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/StatusCodeTimelineData'
'500':
$ref: '#/components/responses/InternalServerError'
/stats/heatmap/traffic:
get:
tags:
- Timeline
summary: Get traffic heatmap
description: |
Returns hourly traffic data grouped by day of week for heatmap visualization.
Supports service filtering and hide my traffic functionality.
operationId: getTrafficHeatmap
parameters:
- $ref: '#/components/parameters/ServiceFilter'
- $ref: '#/components/parameters/ServiceTypeFilter'
- $ref: '#/components/parameters/ServicesArray'
- $ref: '#/components/parameters/ServiceTypesArray'
- $ref: '#/components/parameters/HostFilter'
- $ref: '#/components/parameters/DaysParam'
- $ref: '#/components/parameters/ExcludeOwnIP'
- $ref: '#/components/parameters/ExcludeServices'
- $ref: '#/components/parameters/ExcludeServiceTypes'
responses:
'200':
description: Traffic heatmap data
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/TrafficHeatmapData'
'500':
$ref: '#/components/responses/InternalServerError'
/stats/top/paths:
get:
tags:
- Top Statistics
summary: Get top paths
description: Returns most accessed paths/URLs with hits, visitors, response time, and bandwidth
operationId: getTopPaths
parameters:
- $ref: '#/components/parameters/ServiceFilter'
- $ref: '#/components/parameters/ServiceTypeFilter'
- $ref: '#/components/parameters/ServicesArray'
- $ref: '#/components/parameters/ServiceTypesArray'
- $ref: '#/components/parameters/HostFilter'
- $ref: '#/components/parameters/HoursParam'
- $ref: '#/components/parameters/ExcludeOwnIP'
- $ref: '#/components/parameters/ExcludeServices'
- $ref: '#/components/parameters/ExcludeServiceTypes'
responses:
'200':
description: Top paths
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/PathStats'
'500':
$ref: '#/components/responses/InternalServerError'
/stats/top/countries:
get:
tags:
- Top Statistics
summary: Get top countries
description: Returns countries with the most traffic
operationId: getTopCountries
parameters:
- $ref: '#/components/parameters/ServiceFilter'
- $ref: '#/components/parameters/ServiceTypeFilter'
- $ref: '#/components/parameters/ServicesArray'
- $ref: '#/components/parameters/ServiceTypesArray'
- $ref: '#/components/parameters/HostFilter'
- $ref: '#/components/parameters/HoursParam'
- $ref: '#/components/parameters/ExcludeOwnIP'
- $ref: '#/components/parameters/ExcludeServices'
- $ref: '#/components/parameters/ExcludeServiceTypes'
- name: limit
in: query
description: Maximum number of results (0-500, default 10)
schema:
type: integer
minimum: 0
maximum: 500
default: 10
responses:
'200':
description: Top countries
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/CountryStats'
'500':
$ref: '#/components/responses/InternalServerError'
/stats/top/ips:
get:
tags:
- Top Statistics
summary: Get top IP addresses
description: Returns IP addresses with the most requests
operationId: getTopIPs
parameters:
- $ref: '#/components/parameters/ServiceFilter'
- $ref: '#/components/parameters/ServiceTypeFilter'
- $ref: '#/components/parameters/ServicesArray'
- $ref: '#/components/parameters/ServiceTypesArray'
- $ref: '#/components/parameters/HostFilter'
- $ref: '#/components/parameters/HoursParam'
- $ref: '#/components/parameters/ExcludeOwnIP'
- $ref: '#/components/parameters/ExcludeServices'
- $ref: '#/components/parameters/ExcludeServiceTypes'
responses:
'200':
description: Top IP addresses
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/IPStats'
'500':
$ref: '#/components/responses/InternalServerError'
/stats/top/user-agents:
get:
tags:
- Top Statistics
summary: Get top user agents
description: Returns most common user agent strings
operationId: getTopUserAgents
parameters:
- $ref: '#/components/parameters/ServiceFilter'
- $ref: '#/components/parameters/ServiceTypeFilter'
- $ref: '#/components/parameters/ServicesArray'
- $ref: '#/components/parameters/ServiceTypesArray'
- $ref: '#/components/parameters/HostFilter'
- $ref: '#/components/parameters/HoursParam'
- $ref: '#/components/parameters/ExcludeOwnIP'
- $ref: '#/components/parameters/ExcludeServices'
- $ref: '#/components/parameters/ExcludeServiceTypes'
responses:
'200':
description: Top user agents
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/UserAgentStats'
'500':
$ref: '#/components/responses/InternalServerError'
/stats/top/browsers:
get:
tags:
- Top Statistics
summary: Get top browsers
description: Returns most common browsers
operationId: getTopBrowsers
parameters:
- $ref: '#/components/parameters/ServiceFilter'
- $ref: '#/components/parameters/ServiceTypeFilter'
- $ref: '#/components/parameters/ServicesArray'
- $ref: '#/components/parameters/ServiceTypesArray'
- $ref: '#/components/parameters/HostFilter'
- $ref: '#/components/parameters/HoursParam'
- $ref: '#/components/parameters/ExcludeOwnIP'
- $ref: '#/components/parameters/ExcludeServices'
- $ref: '#/components/parameters/ExcludeServiceTypes'
responses:
'200':
description: Top browsers
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/BrowserStats'
'500':
$ref: '#/components/responses/InternalServerError'
/stats/top/operating-systems:
get:
tags:
- Top Statistics
summary: Get top operating systems
description: Returns most common operating systems
operationId: getTopOperatingSystems
parameters:
- $ref: '#/components/parameters/ServiceFilter'
- $ref: '#/components/parameters/ServiceTypeFilter'
- $ref: '#/components/parameters/ServicesArray'
- $ref: '#/components/parameters/ServiceTypesArray'
- $ref: '#/components/parameters/HostFilter'
- $ref: '#/components/parameters/HoursParam'
- $ref: '#/components/parameters/ExcludeOwnIP'
- $ref: '#/components/parameters/ExcludeServices'
- $ref: '#/components/parameters/ExcludeServiceTypes'
responses:
'200':
description: Top operating systems
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/OSStats'
'500':
$ref: '#/components/responses/InternalServerError'
/stats/top/asns:
get:
tags:
- Top Statistics
summary: Get top ASNs
description: Returns Autonomous System Numbers with the most traffic
operationId: getTopASNs
parameters:
- $ref: '#/components/parameters/ServiceFilter'
- $ref: '#/components/parameters/ServiceTypeFilter'
- $ref: '#/components/parameters/ServicesArray'
- $ref: '#/components/parameters/ServiceTypesArray'
- $ref: '#/components/parameters/HostFilter'
- $ref: '#/components/parameters/HoursParam'
- $ref: '#/components/parameters/ExcludeOwnIP'
- $ref: '#/components/parameters/ExcludeServices'
- $ref: '#/components/parameters/ExcludeServiceTypes'
responses:
'200':
description: Top ASNs
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ASNStats'
'500':
$ref: '#/components/responses/InternalServerError'
/stats/top/backends:
get:
tags:
- Top Statistics
summary: Get top backends
description: Returns backend services with traffic and performance metrics
operationId: getTopBackends
parameters:
- $ref: '#/components/parameters/ServiceFilter'
- $ref: '#/components/parameters/ServiceTypeFilter'
- $ref: '#/components/parameters/ServicesArray'
- $ref: '#/components/parameters/ServiceTypesArray'
- $ref: '#/components/parameters/HostFilter'
- $ref: '#/components/parameters/HoursParam'
- $ref: '#/components/parameters/ExcludeOwnIP'
- $ref: '#/components/parameters/ExcludeServices'
- $ref: '#/components/parameters/ExcludeServiceTypes'
responses:
'200':
description: Top backends
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/BackendStats'
'500':
$ref: '#/components/responses/InternalServerError'
/stats/top/referrers:
get:
tags:
- Top Statistics
summary: Get top referrers
description: Returns top referrer URLs
operationId: getTopReferrers
parameters:
- $ref: '#/components/parameters/ServiceFilter'
- $ref: '#/components/parameters/ServiceTypeFilter'
- $ref: '#/components/parameters/ServicesArray'
- $ref: '#/components/parameters/ServiceTypesArray'
- $ref: '#/components/parameters/HostFilter'
- $ref: '#/components/parameters/HoursParam'
- $ref: '#/components/parameters/ExcludeOwnIP'
- $ref: '#/components/parameters/ExcludeServices'
- $ref: '#/components/parameters/ExcludeServiceTypes'
- name: limit
in: query
description: Maximum number of results (1-100, default 10)
schema:
type: integer
minimum: 1
maximum: 100
default: 10
responses:
'200':
description: Top referrers
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ReferrerStats'
'500':
$ref: '#/components/responses/InternalServerError'
/stats/top/referrer-domains:
get:
tags:
- Top Statistics
summary: Get top referrer domains
description: Returns aggregated referrer traffic by domain
operationId: getTopReferrerDomains
parameters:
- $ref: '#/components/parameters/ServiceFilter'
- $ref: '#/components/parameters/ServiceTypeFilter'
- $ref: '#/components/parameters/ServicesArray'
- $ref: '#/components/parameters/ServiceTypesArray'
- $ref: '#/components/parameters/HostFilter'
- $ref: '#/components/parameters/HoursParam'
- $ref: '#/components/parameters/ExcludeOwnIP'
- $ref: '#/components/parameters/ExcludeServices'
- $ref: '#/components/parameters/ExcludeServiceTypes'
- name: limit
in: query
description: Maximum number of results (0 = unlimited, default 10)
schema:
type: integer
minimum: 0
default: 10
responses:
'200':
description: Top referrer domains
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ReferrerDomainStats'
'500':
$ref: '#/components/responses/InternalServerError'
/stats/distribution/status-codes:
get:
tags:
- Distributions
summary: Get status code distribution
description: Returns distribution of HTTP status codes
operationId: getStatusCodeDistribution
parameters:
- $ref: '#/components/parameters/ServiceFilter'
- $ref: '#/components/parameters/ServiceTypeFilter'
- $ref: '#/components/parameters/ServicesArray'
- $ref: '#/components/parameters/ServiceTypesArray'
- $ref: '#/components/parameters/HostFilter'
- $ref: '#/components/parameters/HoursParam'
- $ref: '#/components/parameters/ExcludeOwnIP'
- $ref: '#/components/parameters/ExcludeServices'
- $ref: '#/components/parameters/ExcludeServiceTypes'
responses:
'200':
description: Status code distribution
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/StatusCodeStats'
'500':
$ref: '#/components/responses/InternalServerError'
/stats/distribution/methods:
get:
tags:
- Distributions
summary: Get HTTP method distribution
description: Returns distribution of HTTP methods (GET, POST, etc.)
operationId: getMethodDistribution
parameters:
- $ref: '#/components/parameters/ServiceFilter'
- $ref: '#/components/parameters/ServiceTypeFilter'
- $ref: '#/components/parameters/ServicesArray'
- $ref: '#/components/parameters/ServiceTypesArray'
- $ref: '#/components/parameters/HostFilter'
- $ref: '#/components/parameters/HoursParam'
- $ref: '#/components/parameters/ExcludeOwnIP'
- $ref: '#/components/parameters/ExcludeServices'
- $ref: '#/components/parameters/ExcludeServiceTypes'
responses:
'200':
description: HTTP method distribution
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/MethodStats'
'500':
$ref: '#/components/responses/InternalServerError'
/stats/distribution/protocols:
get:
tags:
- Distributions
summary: Get protocol distribution
description: Returns distribution of HTTP protocols (HTTP/1.1, HTTP/2, etc.)
operationId: getProtocolDistribution
parameters:
- $ref: '#/components/parameters/ServiceFilter'
- $ref: '#/components/parameters/ServiceTypeFilter'
- $ref: '#/components/parameters/ServicesArray'
- $ref: '#/components/parameters/ServiceTypesArray'
- $ref: '#/components/parameters/HostFilter'
- $ref: '#/components/parameters/HoursParam'
- $ref: '#/components/parameters/ExcludeOwnIP'
- $ref: '#/components/parameters/ExcludeServices'
- $ref: '#/components/parameters/ExcludeServiceTypes'
responses:
'200':
description: Protocol distribution
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ProtocolStats'
'500':
$ref: '#/components/responses/InternalServerError'
/stats/distribution/tls-versions:
get:
tags:
- Distributions
summary: Get TLS version distribution
description: Returns distribution of TLS/SSL versions
operationId: getTLSVersionDistribution
parameters:
- $ref: '#/components/parameters/ServiceFilter'
- $ref: '#/components/parameters/ServiceTypeFilter'
- $ref: '#/components/parameters/ServicesArray'
- $ref: '#/components/parameters/ServiceTypesArray'
- $ref: '#/components/parameters/HostFilter'
- $ref: '#/components/parameters/HoursParam'
- $ref: '#/components/parameters/ExcludeOwnIP'
- $ref: '#/components/parameters/ExcludeServices'
- $ref: '#/components/parameters/ExcludeServiceTypes'
responses:
'200':
description: TLS version distribution
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/TLSVersionStats'
'500':
$ref: '#/components/responses/InternalServerError'
/stats/distribution/device-types:
get:
tags:
- Distributions
summary: Get device type distribution
description: Returns distribution of device types (desktop, mobile, tablet, bot)
operationId: getDeviceTypeDistribution
parameters:
- $ref: '#/components/parameters/ServiceFilter'
- $ref: '#/components/parameters/ServiceTypeFilter'
- $ref: '#/components/parameters/ServicesArray'
- $ref: '#/components/parameters/ServiceTypesArray'
- $ref: '#/components/parameters/HostFilter'
- $ref: '#/components/parameters/HoursParam'
- $ref: '#/components/parameters/ExcludeOwnIP'
- $ref: '#/components/parameters/ExcludeServices'
- $ref: '#/components/parameters/ExcludeServiceTypes'
responses:
'200':
description: Device type distribution
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/DeviceTypeStats'
'500':
$ref: '#/components/responses/InternalServerError'
/stats/performance/response-time:
get:
tags:
- Performance
summary: Get response time statistics
description: Returns response time metrics including min, max, avg, and percentiles
operationId: getResponseTimeStats
parameters:
- $ref: '#/components/parameters/ServiceFilter'
- $ref: '#/components/parameters/ServiceTypeFilter'
- $ref: '#/components/parameters/ServicesArray'
- $ref: '#/components/parameters/ServiceTypesArray'
- $ref: '#/components/parameters/HostFilter'
- $ref: '#/components/parameters/HoursParam'
- $ref: '#/components/parameters/ExcludeOwnIP'
- $ref: '#/components/parameters/ExcludeServices'
- $ref: '#/components/parameters/ExcludeServiceTypes'
responses:
'200':
description: Response time statistics
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseTimeStats'
'500':
$ref: '#/components/responses/InternalServerError'
/stats/log-processing:
get:
tags:
- System
summary: Get log processing statistics
description: |
Returns information about log file processing progress.
**Percentage Calculation:**
The processing percentage is intelligently calculated using:
1. **Record-based estimation**: Calculates average bytes per record and estimates total records in file for accurate progress
2. **Byte-based fallback**: Uses file position vs file size if records aren't available yet
3. **Real-time updates**: Position updates every 500ms during active processing for smooth progress tracking
**Use Cases:**
- Monitor initial log import progress
- Track ongoing log processing status
- Display loading screens with accurate ETAs
- Ensure logs are fully processed before showing analytics
operationId: getLogProcessingStats
responses:
'200':
description: Log processing statistics
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/LogProcessingStats'
example:
- log_source_name: "traefik-access"
file_size: 104857600
bytes_processed: 52428800
percentage: 50.0
last_processed_at: "2025-11-06T10:30:15Z"
'500':
$ref: '#/components/responses/InternalServerError'
/requests/recent:
get:
tags:
- Requests
summary: Get recent requests
description: Returns the most recent HTTP requests with full details
operationId: getRecentRequests
parameters:
- $ref: '#/components/parameters/ServiceFilter'
- $ref: '#/components/parameters/ServiceTypeFilter'
- $ref: '#/components/parameters/ServicesArray'
- $ref: '#/components/parameters/ServiceTypesArray'
- $ref: '#/components/parameters/HostFilter'
- $ref: '#/components/parameters/ExcludeOwnIP'
- $ref: '#/components/parameters/ExcludeServices'
- $ref: '#/components/parameters/ExcludeServiceTypes'
- name: limit
in: query
description: Maximum number of results (1-1000, default 100)
schema:
type: integer
minimum: 1
maximum: 1000
default: 100
- name: offset
in: query
description: Pagination offset
schema:
type: integer
minimum: 0
default: 0
responses:
'200':
description: Recent requests
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/HTTPRequest'
'500':
$ref: '#/components/responses/InternalServerError'
/realtime/metrics:
get:
tags:
- Real-time
summary: Get current real-time metrics
description: Returns a single snapshot of current real-time metrics
operationId: getCurrentMetrics
responses:
'200':
description: Current real-time metrics
content:
application/json:
schema:
$ref: '#/components/schemas/RealtimeMetrics'
'500':
$ref: '#/components/responses/InternalServerError'
/realtime/services:
get:
tags:
- Real-time
summary: Get per-service metrics
description: Returns real-time metrics broken down by service/backend
operationId: getPerServiceMetrics
responses:
'200':
description: Per-service metrics
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ServiceMetrics'
'500':
$ref: '#/components/responses/InternalServerError'
/realtime/stream:
get:
tags:
- Real-time
summary: Stream real-time metrics
description: |
Server-Sent Events (SSE) endpoint that streams real-time metrics.
Connect using EventSource API in JavaScript or any SSE client.
Example JavaScript:
```javascript
const eventSource = new EventSource('http://localhost:8080/api/v1/realtime/stream');
eventSource.onmessage = (event) => {
const metrics = JSON.parse(event.data);
console.log('Real-time metrics:', metrics);
};
```
operationId: streamMetrics
responses:
'200':
description: SSE stream of real-time metrics
content:
text/event-stream:
schema:
$ref: '#/components/schemas/RealtimeMetrics'
/services:
get:
tags:
- System
summary: Get available services with types
description: |
Returns list of all available services with their identification types and request counts.
**Service Types** (priority-based):
1. `backend_name`: Traefik backend name (highest priority)
2. `backend_url`: Backend URL
3. `host`: HTTP Host header (lowest priority)
The API intelligently selects the best available identifier for each service.
Use this endpoint to discover available services for filtering in other API calls.
operationId: getServices
responses:
'200':
description: List of services with types and request counts
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ServiceInfo'
'500':
$ref: '#/components/responses/InternalServerError'
/widget/data:
get:
tags:
- Widget
summary: Get real-time widget data
description: |
Returns compact real-time metrics optimized for widget embedding.
Shows data from the last hour with requests per minute calculation.
**Note**: This endpoint is only available when `WIDGET_ENABLED=true` (default).
operationId: getWidgetData
responses:
'200':
description: Real-time widget data
content:
application/json:
schema:
$ref: '#/components/schemas/WidgetRealtimeData'
'404':
description: Widget endpoints disabled
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'500':
$ref: '#/components/responses/InternalServerError'
/widget/summary:
get:
tags:
- Widget
summary: Get widget summary data for a time period
description: |
Returns compact summary statistics for embedding in widgets.
Optimized for displaying aggregated data over a time period.
**Note**: This endpoint is only available when `WIDGET_ENABLED=true` (default).
operationId: getWidgetSummary
parameters:
- name: hours
in: query
description: Number of hours to analyze (1-720 for up to 30 days, default 24)
schema:
type: integer
minimum: 1
maximum: 720
default: 24
example: 24
responses:
'200':
description: Widget summary data
content:
application/json:
schema:
$ref: '#/components/schemas/WidgetSummaryData'
'404':
description: Widget endpoints disabled
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'500':
$ref: '#/components/responses/InternalServerError'
/widget/timeline:
get:
tags:
- Widget
summary: Get widget timeline data
description: |
Returns compact timeline data optimized for sparkline charts in widgets.
Returns up to 30 data points for periods <= 24 hours, or 50 points for longer periods.
**Note**: This endpoint is only available when `WIDGET_ENABLED=true` (default).
operationId: getWidgetTimeline
parameters:
- name: hours
in: query
description: Number of hours to analyze (1-720 for up to 30 days, default 24)
schema:
type: integer
minimum: 1
maximum: 720
default: 24
example: 24
responses:
'200':
description: Widget timeline data
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/WidgetTimelinePoint'
'404':
description: Widget endpoints disabled
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'500':
$ref: '#/components/responses/InternalServerError'
/ip/search:
get:
tags:
- IP Analytics
summary: Search for IP addresses
description: Search for IP addresses by partial match with basic statistics
operationId: searchIPs
parameters:
- name: q
in: query