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
|
{
"swagger": "2.0",
"info": {
"title": "NetData API",
"description": "Real time data collection and graphs...",
"version": "1.0.0"
},
"host": "netdata.firehol.org",
"schemes": [
"http"
],
"basePath": "/api/v1",
"produces": [
"application/json"
],
"paths": {
"/charts": {
"get": {
"summary": "Get a list of all charts available at the server",
"description": "The charts endpoint returns a summary about all charts stored in the netdata server.",
"responses": {
"200": {
"description": "An array of charts",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/chart_summary"
}
}
}
}
}
},
"/chart": {
"get": {
"summary": "Get info about a specific chart",
"description": "The Chart endpoint returns detailed information about a chart.",
"parameters": [
{
"name": "chart",
"in": "query",
"description": "The id of the chart as returned by the /charts call.",
"required": true,
"type": "string",
"format": "as returned by /charts",
"default": "system.cpu"
}
],
"responses": {
"200": {
"description": "A javascript object with detailed information about the chart.",
"schema": {
"$ref": "#/definitions/chart"
}
},
"404": {
"description": "No chart with the given id is found."
}
}
}
},
"/data": {
"get": {
"summary": "Get collected data for a specific chart",
"description": "The Data endpoint returns data stored in the round robin database of a chart.\n",
"parameters": [
{
"name": "chart",
"in": "query",
"description": "The id of the chart as returned by the /charts call.",
"required": true,
"type": "string",
"format": "as returned by /charts",
"allowEmptyValue": false,
"default": "system.cpu"
},
{
"name": "dimension",
"in": "query",
"description": "zero, one or more dimension ids, as returned by the /chart call.",
"required": false,
"type": "array",
"items": {
"type": "string",
"collectionFormat": "pipes",
"format": "as returned by /charts"
},
"allowEmptyValue": false
},
{
"name": "after",
"in": "query",
"description": "This parameter can either be an absolute timestamp specifying the starting point of the data to be returned, or a relative number of seconds, to the last collected timestamp. Netdata will assume it is a relative number if it is smaller than the duration of the round robin database for this chart. So, if the round robin database is 3600 seconds, any value from -3600 to 3600 will trigger relative arithmetics. Netdata will adapt this parameter to the boundaries of the round robin database.",
"required": true,
"type": "number",
"format": "integer",
"allowEmptyValue": false,
"default": -600
},
{
"name": "before",
"in": "query",
"description": "This parameter can either be an absolute timestamp specifying the ending point of the data to be returned, or a relative number of seconds, to the last collected timestamp. Netdata will assume it is a relative number if it is smaller than the duration of the round robin database for this chart. So, if the round robin database is 3600 seconds, any value from -3600 to 3600 will trigger relative arithmetics. Netdata will adapt this parameter to the boundaries of the round robin database.",
"required": false,
"type": "number",
"format": "integer",
"default": 0
},
{
"name": "points",
"in": "query",
"description": "The number of points to be returned. If not given, or it is <= 0, or it is bigger than the points stored in the round robin database for this chart for the given duration, all the available collected values for the given duration are returned.",
"required": true,
"type": "number",
"format": "integer",
"allowEmptyValue": false,
"default": 20
},
{
"name": "group",
"in": "query",
"description": "The grouping method. If multiple collected values are to be grouped in order to return fewer points, this parameters defines the method of grouping. Two methods are supported, \"max\" and \"average\". \"max\" is actually calculated on the absolute value collected (so it works for both positive and negative dimesions to return the most extreme value in either direction).",
"required": true,
"type": "string",
"enum": [
"max",
"average"
],
"default": "average",
"allowEmptyValue": false
},
{
"name": "format",
"in": "query",
"description": "The format of the data to be returned.",
"required": true,
"type": "string",
"enum": [
"json",
"jsonp",
"csv",
"tsv",
"tsv-excel",
"ssv",
"ssvcomma",
"datatable",
"datasource",
"html",
"array",
"csvjsonarray"
],
"default": "json",
"allowEmptyValue": false
},
{
"name": "options",
"in": "query",
"description": "Options that affect data generation.",
"required": false,
"type": "array",
"items": {
"type": "string",
"enum": [
"nonzero",
"flip",
"jsonwrap",
"min2max",
"seconds",
"milliseconds",
"abs",
"absolute",
"absolute-sum",
"null2zero",
"objectrows",
"google_json",
"percentage"
],
"collectionFormat": "pipes"
},
"default": [
"seconds",
"jsonwrap"
],
"allowEmptyValue": false
},
{
"name": "callback",
"in": "query",
"description": "For JSONP responses, the callback function name.",
"required": false,
"type": "string",
"allowEmptyValue": true
},
{
"name": "filename",
"in": "query",
"description": "Add Content-Disposition: attachment; filename=<filename> header to the response, that will instruct the browser to save the response with the given filename.",
"required": false,
"type": "string",
"allowEmptyValue": true
},
{
"name": "tqx",
"in": "query",
"description": "[Google Visualization API](https://developers.google.com/chart/interactive/docs/dev/implementing_data_source?hl=en) formatted parameter.",
"required": false,
"type": "string",
"allowEmptyValue": true
}
],
"responses": {
"200": {
"description": "The call was successful. The response should include the data.",
"schema": {
"$ref": "#/definitions/chart"
}
},
"400": {
"description": "Bad request - the body will include a message stating what is wrong."
},
"404": {
"description": "No chart with the given id is found."
},
"500": {
"description": "Internal server error. This usually means the server is out of memory."
}
}
}
}
},
"definitions": {
"chart_summary": {
"type": "object",
"properties": {
"hostname": {
"type": "string",
"description": "The hostname of the netdata server."
},
"update_every": {
"type": "number",
"description": "The default update frequency of the netdata server. All charts have an update frequency equal or bigger than this."
},
"charts": {
"type": "object",</
|
