4 description: 'Real time data collection and graphs...'
6 host: registry.my-netdata.io
15 summary: 'Get a list of all charts available at the server'
16 description: 'The charts endpoint returns a summary about all charts stored in the netdata server.'
19 description: 'An array of charts'
23 $ref: '#/definitions/chart_summary'
26 summary: 'Get info about a specific chart'
27 description: 'The Chart endpoint returns detailed information about a chart.'
31 description: 'The id of the chart as returned by the /charts call.'
34 format: 'as returned by /charts'
38 description: 'A javascript object with detailed information about the chart.'
40 $ref: '#/definitions/chart'
42 description: 'No chart with the given id is found.'
45 summary: 'Get collected data for a specific chart'
47 The Data endpoint returns data stored in the round robin database of a chart.
51 description: 'The id of the chart as returned by the /charts call.'
54 format: 'as returned by /charts'
55 allowEmptyValue: false
59 description: 'zero, one or more dimension ids, as returned by the /chart call.'
64 collectionFormat: pipes
65 format: 'as returned by /charts'
66 allowEmptyValue: false
69 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 (negative, relative to parameter: before). Netdata will assume it is a relative number if it is less that 3 years (in seconds). Netdata will adapt this parameter to the boundaries of the round robin database. The default is the beginning of the round robin database (i.e. by default netdata will attempt to return data for the entire database).'
73 allowEmptyValue: false
77 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 (negative), relative to the last collected timestamp. Netdata will assume it is a relative number if it is less than 3 years (in seconds). Netdata will adapt this parameter to the boundaries of the round robin database. The default is zero (i.e. the timestamp of the last value collected).'
84 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 will be returned.'
88 allowEmptyValue: false
92 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. methods supported "min", "max", "average", "sum", "incremental-sum". "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).'
95 enum: [ 'min', 'max', 'average', 'sum', 'incremental-sum' ]
97 allowEmptyValue: false
100 description: 'The format of the data to be returned.'
103 enum: [ 'json', 'jsonp', 'csv', 'tsv', 'tsv-excel', 'ssv', 'ssvcomma', 'datatable', 'datasource', 'html', 'array', 'csvjsonarray' ]
105 allowEmptyValue: false
108 description: 'Options that affect data generation.'
113 enum: [ 'nonzero', 'flip', 'jsonwrap', 'min2max', 'seconds', 'milliseconds', 'abs', 'absolute', 'absolute-sum', 'null2zero', 'objectrows', 'google_json', 'percentage', 'unaligned' ]
114 collectionFormat: pipes
115 default: [seconds, jsonwrap]
116 allowEmptyValue: false
119 description: 'For JSONP responses, the callback function name.'
122 allowEmptyValue: true
125 description: 'Add Content-Disposition: attachment; filename=<filename> header to the response, that will instruct the browser to save the response with the given filename.'
128 allowEmptyValue: true
131 description: '[Google Visualization API](https://developers.google.com/chart/interactive/docs/dev/implementing_data_source?hl=en) formatted parameter.'
134 allowEmptyValue: true
137 description: 'The call was successful. The response should include the data.'
139 $ref: '#/definitions/chart'
141 description: 'Bad request - the body will include a message stating what is wrong.'
143 description: 'No chart with the given id is found.'
145 description: 'Internal server error. This usually means the server is out of memory.'
148 summary: 'Generate a SVG image for a chart (or dimension)'
150 Successful responses are SVG images
154 description: 'The id of the chart as returned by the /charts call.'
157 format: 'as returned by /charts'
158 allowEmptyValue: false
162 description: 'the name of an alarm linked to the chart'
166 allowEmptyValue: true
169 description: 'zero, one or more dimension ids, as returned by the /chart call.'
174 collectionFormat: pipes
175 format: 'as returned by /charts'
176 allowEmptyValue: false
179 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.'
183 allowEmptyValue: false
187 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.'
194 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. methods are supported "min", "max", "average", "sum", "incremental-sum". "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).'
197 enum: [ 'min', 'max', 'average', 'sum', 'incremental-sum' ]
199 allowEmptyValue: false
202 description: 'Options that affect data generation.'
207 enum: [ 'abs', 'absolute', 'absolute-sum', 'null2zero', 'percentage', 'unaligned' ]
208 collectionFormat: pipes
209 default: ['absolute']
210 allowEmptyValue: true
213 description: 'a text to be used as the label'
217 allowEmptyValue: true
220 description: 'a text to be used as the units'
224 allowEmptyValue: true
227 description: 'a color to be used for the background of the label'
231 allowEmptyValue: true
234 description: 'a color to be used for the background of the label. You can set multiple using a pipe with a condition each, like this: color<value|color>value|color:null The following operators are supported: >, <, >=, <=, =, :null (to check if no value exists).'
238 allowEmptyValue: true
241 description: 'multiply the value with this number for rendering it at the image (integer value required)'
245 allowEmptyValue: true
248 description: 'divide the value with this number for rendering it at the image (integer value required)'
252 allowEmptyValue: true
255 description: 'The call was successful. The response should be an SVG image.'
257 description: 'Bad request - the body will include a message stating what is wrong.'
259 description: 'No chart with the given id is found.'
261 description: 'Internal server error. This usually means the server is out of memory.'
264 summary: 'Get a value of all the metrics maintained by netdata'
265 description: 'The charts endpoint returns the latest value of all charts and dimensions stored in the netdata server.'
269 description: 'The format of the response to be returned'
272 enum: [ 'shell', 'prometheus' ]
276 description: 'All the metrics returned in the format requested'
278 description: 'The format requested is not supported'
285 description: 'The hostname of the netdata server.'
288 description: 'netdata version of the server.'
291 description: 'The netdata server host operating system.'
292 enum: [ 'macos', 'linux', 'freebsd' ]
295 description: 'The duration, in seconds, of the round robin database maintained by netdata.'
298 description: 'The default update frequency of the netdata server. All charts have an update frequency equal or bigger than this.'
301 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.'
304 $ref: '#/definitions/chart'
307 description: 'The number of charts.'
310 description: 'The total number of dimensions.'
313 description: 'The number of alarms.'
316 description: 'The size of the round robin database in bytes.'
322 description: 'The unique id of the chart'
325 description: 'The name of the chart'
328 description: 'The type of the chart. Types are not handled by netdata. You can use this field for anything you like.'
331 description: 'The family of the chart. Families are not handled by netdata. You can use this field for anything you like.'
334 description: 'The title of the chart.'
337 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.'
340 description: 'True when the chart is enabled. Disabled charts do not currently collect values, but they may have historical values available.'
343 description: 'The unit of measurement for the values of all dimensions of the chart.'
346 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.'
349 description: 'The chart type.'
350 enum: [ 'line', 'area', 'stacked' ]
353 description: 'The duration, in seconds, of the round robin database maintained by netdata.'
356 description: 'The UNIX timestamp of the first entry (the oldest) in the round robin database.'
359 description: 'The UNIX timestamp of the latest entry in the round robin database.'
362 description: 'The update frequency of this chart, in seconds. One value every this amount of time is kept in the round robin database.'
365 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.'
368 $ref: '#/definitions/dimension'
371 description: 'Chart health green threshold'
374 description: 'Chart health red trheshold'
380 description: 'The name of the dimension'
387 description: 'The API version this conforms to, currently 1'
390 description: 'The unique id of the chart'
393 description: 'The name of the chart'
396 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).'
399 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.'
402 description: 'The UNIX timestamp of the first entry (the oldest) in the round robin database (indepedently of the current view).'
405 description: 'The UNIX timestamp of the latest entry in the round robin database (indepedently of the current view).'
408 description: 'The UNIX timestamp of the first entry (the oldest) returned in this response.'
411 description: 'The UNIX timestamp of the latest entry returned in this response.'
414 description: 'The minimum value returned in the current view. This can be used to size the y-series of the chart.'
417 description: 'The maximum value returned in the current view. This can be used to size the y-series of the chart.'
419 description: 'The dimension names of the chart as returned in the current view.'
424 description: 'The dimension IDs of the chart as returned in the current view.'
429 description: 'The latest values collected for the chart (indepedently of the current view).'
434 description: 'The latest values returned with this response.'
440 description: 'The number of dimensions returned.'
443 description: 'The number of rows / points returned.'
446 description: 'The format of the result returned.'
448 description: 'The result requested, in the format requested.'