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
|
# ErrorTrackingOpenAPI::EventsApi
All URIs are relative to *https://localhost/errortracking/api/v1*
| Method | HTTP request | Description |
| ------ | ------------ | ----------- |
| [**list_events**](EventsApi.md#list_events) | **GET** /projects/{projectId}/errors/{fingerprint}/events | Get information about the events related to the error |
| [**projects_api_project_id_envelope_post**](EventsApi.md#projects_api_project_id_envelope_post) | **POST** /projects/api/{projectId}/envelope | Ingestion endpoint for error events sent from client SDKs |
| [**projects_api_project_id_store_post**](EventsApi.md#projects_api_project_id_store_post) | **POST** /projects/api/{projectId}/store | Ingestion endpoint for error events sent from client SDKs |
## list_events
> <Array<ErrorEvent>> list_events(project_id, fingerprint, opts)
Get information about the events related to the error
### 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::EventsApi.new
project_id = 56 # Integer | ID of the project where the error was created
fingerprint = 56 # Integer | ID of the error within the project
opts = {
sort: 'occurred_at_asc', # String |
cursor: 'cursor_example', # String | Base64 encoded information for pagination
limit: 56 # Integer | Number of entries to return
}
begin
# Get information about the events related to the error
result = api_instance.list_events(project_id, fingerprint, opts)
p result
rescue ErrorTrackingOpenAPI::ApiError => e
puts "Error when calling EventsApi->list_events: #{e}"
end
```
#### Using the list_events_with_http_info variant
This returns an Array which contains the response data, status code and headers.
> <Array(<Array<ErrorEvent>>, Integer, Hash)> list_events_with_http_info(project_id, fingerprint, opts)
```ruby
begin
# Get information about the events related to the error
data, status_code, headers = api_instance.list_events_with_http_info(project_id, fingerprint, opts)
p status_code # => 2xx
p headers # => { ... }
p data # => <Array<ErrorEvent>>
rescue ErrorTrackingOpenAPI::ApiError => e
puts "Error when calling EventsApi->list_events_with_http_info: #{e}"
end
```
### Parameters
| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **project_id** | **Integer** | ID of the project where the error was created | |
| **fingerprint** | **Integer** | ID of the error within the project | |
| **sort** | **String** | | [optional][default to 'occurred_at_asc'] |
| **cursor** | **String** | Base64 encoded information for pagination | [optional] |
| **limit** | **Integer** | Number of entries to return | [optional][default to 20] |
### Return type
[**Array<ErrorEvent>**](ErrorEvent.md)
### Authorization
[internalToken](../README.md#internalToken)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: */*
## projects_api_project_id_envelope_post
> <ErrorEvent> projects_api_project_id_envelope_post(project_id)
Ingestion endpoint for error events sent from client SDKs
### 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::EventsApi.new
project_id = 56 # Integer | ID of the project where the error was created
begin
# Ingestion endpoint for error events sent from client SDKs
result = api_instance.projects_api_project_id_envelope_post(project_id)
p result
rescue ErrorTrackingOpenAPI::ApiError => e
puts "Error when calling EventsApi->projects_api_project_id_envelope_post: #{e}"
end
```
#### Using the projects_api_project_id_envelope_post_with_http_info variant
This returns an Array which contains the response data, status code and headers.
> <Array(<ErrorEvent>, Integer, Hash)> projects_api_project_id_envelope_post_with_http_info(project_id)
```ruby
begin
# Ingestion endpoint for error events sent from client SDKs
data, status_code, headers = api_instance.projects_api_project_id_envelope_post_with_http_info(project_id)
p status_code # => 2xx
p headers # => { ... }
p data # => <ErrorEvent>
rescue ErrorTrackingOpenAPI::ApiError => e
puts "Error when calling EventsApi->projects_api_project_id_envelope_post_with_http_info: #{e}"
end
```
### Parameters
| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **project_id** | **Integer** | ID of the project where the error was created | |
### Return type
[**ErrorEvent**](ErrorEvent.md)
### Authorization
[internalToken](../README.md#internalToken)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: */*
## projects_api_project_id_store_post
> <ErrorEvent> projects_api_project_id_store_post(project_id)
Ingestion endpoint for error events sent from client SDKs
### 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::EventsApi.new
project_id = 56 # Integer | ID of the project where the error was created
begin
# Ingestion endpoint for error events sent from client SDKs
result = api_instance.projects_api_project_id_store_post(project_id)
p result
rescue ErrorTrackingOpenAPI::ApiError => e
puts "Error when calling EventsApi->projects_api_project_id_store_post: #{e}"
end
```
#### Using the projects_api_project_id_store_post_with_http_info variant
This returns an Array which contains the response data, status code and headers.
> <Array(<ErrorEvent>, Integer, Hash)> projects_api_project_id_store_post_with_http_info(project_id)
```ruby
begin
# Ingestion endpoint for error events sent from client SDKs
data, status_code, headers = api_instance.projects_api_project_id_store_post_with_http_info(project_id)
p status_code # => 2xx
p headers # => { ... }
p data # => <ErrorEvent>
rescue ErrorTrackingOpenAPI::ApiError => e
puts "Error when calling EventsApi->projects_api_project_id_store_post_with_http_info: #{e}"
end
```
### Parameters
| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **project_id** | **Integer** | ID of the project where the error was created | |
### Return type
[**ErrorEvent**](ErrorEvent.md)
### Authorization
[internalToken](../README.md#internalToken)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: */*
|
