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
|
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.
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
description: 'An object containing all the chart objects available at the netdata server. This is used as an indexed array. The key of each chart object is the id of the chart.'
properties:
key:
$ref: '#/definitions/chart'
chart:
type: object
properties:
id:
type: string
description: 'The unique id of the chart'
name:
type: string
description: 'The name of the chart'
type:
type: string
description: 'The type of the chart. Types are not handled by netdata. You can use this field for anything you like.'
family:
type: string
description: 'The family of the chart. Families are not handled by netdata. You can use this field for anything you like.'
title:
type: string
description: 'The title of the chart.'
priority:
type: string
description: 'The relative priority of the chart. NetData does not care about priorities. This is just an indication of importance for the chart viewers to sort charts of higher priority (lower number) closer to the top. Priority sorting should only be used among charts of the same type or family.'
enabled:
type: boolean
description: 'True when the chart is enabled. Disabled charts do not currently collect values, but they may have historical values available.'
units:
type: string
description: 'The unit of measurement for the values of all dimensions of the chart.'
data_url:
type: string
description: 'The absolute path to get data values for this chart. You are expected to use this path as the base when constructing the URL to fetch data values for this chart.'
chart_type:
type: string
description: 'The chart type.'
enum: [ 'line', 'area', 'stacked' ]
duration:
type: number
description: 'The duration, in seconds, of the round robin database maintained by netdata.'
first_entry:
type: number
description: 'The UNIX timestamp of the first entry (the oldest) in the round robin database.'
last_entry:
type: number
description: 'The UNIX timestamp of the latest entry in the round robin database.'
update_every:
type: number
description: 'The update frequency of this chart, in seconds. One value every this amount of time is kept in the round robin database.'
dimensions:
type: object
description: 'An object containing all the chart dimensions available for the chart. This is used as an indexed array. The key of the object the id of the dimension.'
properties:
key:
$ref: '#/definitions/dimension'
dimension:
type: object
properties:
name:
type: string
description: 'The name of the dimension'
json_wrap:
type: object
properties:
api:
type: number
description: 'The API version this conforms to, currently 1'
id:
type: string
description: 'The unique id of the chart'
name:
type: string
description: 'The name of the chart'
update_every:
type: number
description: 'The update frequency of this chart, in seconds. One value every this amount of time is kept in the round robin database (indepedently of the current view).'
view_update_every:
type: number
description: 'The current view appropriate update frequency of this chart, in seconds. There is no point to request chart refreshes, using the same settings, more frequently than this.'
first_entry:
type: number
description: 'The UNIX timestamp of the first entry (the oldest) in the round robin database (indepedently of the current view).'
last_entry:
type: number
description: 'The UNIX timestamp of the latest entry in the round robin database (indepedently of the current view).'
after:
type: number
description: 'The UNIX timestamp of the first entry (the oldest) returned in this response.'
before:
type: number
description: 'The UNIX timestamp of the latest entry returned in this response.'
min:
type: number
description: 'The minimum value returned in the current view. This can be used to size the y-series of the chart.'
max:
type: number
description: 'The maximum value returned in the current view. This can be used to size the y-series of the chart.'
dimension_names:
description: 'The dimension names of the chart as returned in the current view.'
type: array
items:
type: string
dimension_ids:
description: 'The dimension IDs of the chart as returned in the current view.'
type: array
items:
type: string
latest_values:
description: 'The latest values collected for the chart (indepedently of the current view).'
type: array
items:
type: string
view_latest_values:
description: 'The latest values returned with this response.'
type: array
items:
type: string
dimensions:
type: number
description: 'The number of dimensions returned.'
points:
type: number
description: 'The number of rows / points returned.'
format:
type: string
description: 'The format of the result returned.'
result:
description: 'The result requested, in the format requested.'
|
