Welcome to mirror list, hosted at ThFree Co, Russian Federation.

ErrorsV2Api.md « docs « error_tracking_open_api « gems - gitlab.com/gitlab-org/gitlab-foss.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
blob: 23f3e43bdf86758e8a8bf25d92954898bba54bc6 (plain)
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
# ErrorTrackingOpenAPI::ErrorsV2Api

All URIs are relative to *https://localhost/errortracking/api/v1*

| Method | HTTP request | Description |
| ------ | ------------ | ----------- |
| [**get_stats_v2**](ErrorsV2Api.md#get_stats_v2) | **GET** /api/0/organizations/{groupId}/stats_v2 | Stats of events received for the group |
| [**list_errors_v2**](ErrorsV2Api.md#list_errors_v2) | **GET** /api/0/organizations/{groupId}/issues/ | List of errors(V2) |
| [**list_projects**](ErrorsV2Api.md#list_projects) | **GET** /api/0/organizations/{groupId}/projects/ | List of projects |


## get_stats_v2

> <Array<StatsObject>> get_stats_v2(group_id)

Stats of events received for the group

### Examples

```ruby
require 'time'
require 'error_tracking_open_api'
# setup authorization
ErrorTrackingOpenAPI.configure do |config|
  # Configure API key authorization: internalToken
  config.api_key['internalToken'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['internalToken'] = 'Bearer'
end

api_instance = ErrorTrackingOpenAPI::ErrorsV2Api.new
group_id = 56 # Integer | ID of the group

begin
  # Stats of events received for the group
  result = api_instance.get_stats_v2(group_id)
  p result
rescue ErrorTrackingOpenAPI::ApiError => e
  puts "Error when calling ErrorsV2Api->get_stats_v2: #{e}"
end
```

#### Using the get_stats_v2_with_http_info variant

This returns an Array which contains the response data, status code and headers.

> <Array(<Array<StatsObject>>, Integer, Hash)> get_stats_v2_with_http_info(group_id)

```ruby
begin
  # Stats of events received for the group
  data, status_code, headers = api_instance.get_stats_v2_with_http_info(group_id)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <Array<StatsObject>>
rescue ErrorTrackingOpenAPI::ApiError => e
  puts "Error when calling ErrorsV2Api->get_stats_v2_with_http_info: #{e}"
end
```

### Parameters

| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **group_id** | **Integer** | ID of the group |  |

### Return type

[**Array&lt;StatsObject&gt;**](StatsObject.md)

### Authorization

[internalToken](../README.md#internalToken)

### HTTP request headers

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


## list_errors_v2

> <Array<ErrorV2>> list_errors_v2(project, group_id, opts)

List of errors(V2)

### Examples

```ruby
require 'time'
require 'error_tracking_open_api'
# setup authorization
ErrorTrackingOpenAPI.configure do |config|
  # Configure API key authorization: internalToken
  config.api_key['internalToken'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['internalToken'] = 'Bearer'
end

api_instance = ErrorTrackingOpenAPI::ErrorsV2Api.new
project = [37] # Array<Integer> | ID of the project where the error was created
group_id = 56 # Integer | ID of the group
opts = {
  status: 'unresolved', # String | 
  query: 'query_example', # String | 
  start: 'start_example', # String | Optional start of the stat period in format 2006-01-02T15:04:05
  _end: '_end_example', # String | Optional end of the stat period in format 2006-01-02T15:04:05
  environment: 'environment_example', # String | 
  limit: 56, # Integer | Number of entries to return
  sort: 'date' # String | Optional sorting column of the entries
}

begin
  # List of errors(V2)
  result = api_instance.list_errors_v2(project, group_id, opts)
  p result
rescue ErrorTrackingOpenAPI::ApiError => e
  puts "Error when calling ErrorsV2Api->list_errors_v2: #{e}"
end
```

#### Using the list_errors_v2_with_http_info variant

This returns an Array which contains the response data, status code and headers.

> <Array(<Array<ErrorV2>>, Integer, Hash)> list_errors_v2_with_http_info(project, group_id, opts)

```ruby
begin
  # List of errors(V2)
  data, status_code, headers = api_instance.list_errors_v2_with_http_info(project, group_id, opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <Array<ErrorV2>>
rescue ErrorTrackingOpenAPI::ApiError => e
  puts "Error when calling ErrorsV2Api->list_errors_v2_with_http_info: #{e}"
end
```

### Parameters

| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **project** | [**Array&lt;Integer&gt;**](Integer.md) | ID of the project where the error was created |  |
| **group_id** | **Integer** | ID of the group |  |
| **status** | **String** |  | [optional][default to &#39;unresolved&#39;] |
| **query** | **String** |  | [optional] |
| **start** | **String** | Optional start of the stat period in format 2006-01-02T15:04:05 | [optional] |
| **_end** | **String** | Optional end of the stat period in format 2006-01-02T15:04:05 | [optional] |
| **environment** | **String** |  | [optional] |
| **limit** | **Integer** | Number of entries to return | [optional][default to 20] |
| **sort** | **String** | Optional sorting column of the entries | [optional][default to &#39;date&#39;] |

### Return type

[**Array&lt;ErrorV2&gt;**](ErrorV2.md)

### Authorization

[internalToken](../README.md#internalToken)

### HTTP request headers

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


## list_projects

> <Array<Project>> list_projects(group_id)

List of projects

### Examples

```ruby
require 'time'
require 'error_tracking_open_api'
# setup authorization
ErrorTrackingOpenAPI.configure do |config|
  # Configure API key authorization: internalToken
  config.api_key['internalToken'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['internalToken'] = 'Bearer'
end

api_instance = ErrorTrackingOpenAPI::ErrorsV2Api.new
group_id = 56 # Integer | ID of the group

begin
  # List of projects
  result = api_instance.list_projects(group_id)
  p result
rescue ErrorTrackingOpenAPI::ApiError => e
  puts "Error when calling ErrorsV2Api->list_projects: #{e}"
end
```

#### Using the list_projects_with_http_info variant

This returns an Array which contains the response data, status code and headers.

> <Array(<Array<Project>>, Integer, Hash)> list_projects_with_http_info(group_id)

```ruby
begin
  # List of projects
  data, status_code, headers = api_instance.list_projects_with_http_info(group_id)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <Array<Project>>
rescue ErrorTrackingOpenAPI::ApiError => e
  puts "Error when calling ErrorsV2Api->list_projects_with_http_info: #{e}"
end
```

### Parameters

| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **group_id** | **Integer** | ID of the group |  |

### Return type

[**Array&lt;Project&gt;**](Project.md)

### Authorization

[internalToken](../README.md#internalToken)

### HTTP request headers

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