limit-lens 0.6.1

A simple API for testing and visualizing rate limiters in real-time. Monitor request throughput and see how your rate limiting algorithms perform under load.
Documentation 
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

# \RateTestApi

All URIs are relative to *http://localhost:6969*

Method | HTTP request | Description
------------- | ------------- | -------------
[**create_test_session**](RateTestApi.md#create_test_session) | **POST** /api/test/session | Create a new test session
[**get_all_sessions**](RateTestApi.md#get_all_sessions) | **GET** /api/test/sessions | Get all active test sessions
[**get_test_metrics**](RateTestApi.md#get_test_metrics) | **GET** /api/test/metrics/{session_id} | Get metrics for a test session
[**metrics_dashboard**](RateTestApi.md#metrics_dashboard) | **GET** /dashboard | Web interface for viewing live metrics
[**receive_test_request**](RateTestApi.md#receive_test_request) | **GET** /api/test/request/{session_id} | Receive a test request



## create_test_session

> models::TestSession create_test_session(create_session_request)
Create a new test session

Returns a unique session ID that can be used for rate limit testing

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**create_session_request** | [**CreateSessionRequest**](CreateSessionRequest.md) |  | [required] |

### Return type

[**models::TestSession**](TestSession.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## get_all_sessions

> Vec<models::TestSession> get_all_sessions()
Get all active test sessions

Returns a list of all active test sessions

### Parameters

This endpoint does not need any parameter.

### Return type

[**Vec<models::TestSession>**](TestSession.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## get_test_metrics

> models::TestMetrics get_test_metrics(session_id)
Get metrics for a test session

Returns metrics and analysis of requests received for a session

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**session_id** | **String** | The test session ID | [required] |

### Return type

[**models::TestMetrics**](TestMetrics.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## metrics_dashboard

> metrics_dashboard()
Web interface for viewing live metrics

Serves an HTML page that displays live metrics for all active sessions

### Parameters

This endpoint does not need any parameter.

### Return type

 (empty response body)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: Not defined

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## receive_test_request

> receive_test_request(session_id)
Receive a test request

Records a request for the specified session ID

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**session_id** | **String** | The test session ID | [required] |

### Return type

 (empty response body)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: Not defined

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)