{"_id":"57fcc4870312b20e00ac651f","version":{"_id":"57fcc4860312b20e00ac64c0","project":"5435687035740020002a1c04","__v":1,"createdAt":"2016-10-11T10:52:54.637Z","releaseDate":"2016-10-11T10:52:54.637Z","categories":["57fcc4860312b20e00ac64c1","57fcc4860312b20e00ac64c2","57fcc4860312b20e00ac64c3","57fcc4860312b20e00ac64c4","57fcc4860312b20e00ac64c5","57fcc4860312b20e00ac64c6","57fcc4860312b20e00ac64c7","57fcc4860312b20e00ac64c8","57fcc4860312b20e00ac64c9","57fcc4860312b20e00ac64ca","57fcc4860312b20e00ac64cb"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"[APP-1265], [APP-1035]","version_clean":"5.2.0","version":"5.2"},"__v":0,"category":{"_id":"57fcc4860312b20e00ac64ca","version":"57fcc4860312b20e00ac64c0","__v":0,"project":"5435687035740020002a1c04","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2014-10-30T22:39:02.374Z","from_sync":false,"order":9,"slug":"flow-data-structures","title":"Flow Data Structures"},"user":"54497cce27b7fc140078d9a5","project":"5435687035740020002a1c04","parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2014-10-31T23:14:21.857Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"settings":"","examples":{"codes":[{"code":"output.values = array({1})\noutput.duration = 60","language":"lua","name":"Agent Lua"}]},"method":"post","results":{"codes":[{"name":"","code":"{\n    \"errors\": [\n    ],\n    \"skipped\": [\n    ],\n    \"updated\": [\n    \t\"your_flow_tag\"\n    ]\n}","language":"json","status":200},{"name":"","code":"{\n    \"errors\": [\n        \"error description\"\n    ],\n    \"skipped\": [\n    \t\"your_flow_tag\"\n    ],\n    \"updated\": [\n    ]\n}","language":"json","status":400}]},"auth":"required","params":[{"_id":"567b28283241c20d00b73060","ref":"","in":"path","required":true,"desc":"The flow tag","default":"","type":"string","name":"streamchart_flow_tag"},{"_id":"567b28283241c20d00b7305f","ref":"","in":"body","required":true,"desc":"Point in time to render on the chart.  Will take up to 6 numbers.","default":"","type":"array_double","name":"values"},{"_id":"567b28283241c20d00b7305e","ref":"","in":"body","required":false,"desc":"The base of the graph. The default is \"dynamic\" which means the base is calculated based on it's values. It can also be \"zero\" which means the base is always 0.","default":"dynamic","type":"string","name":"baseline"},{"_id":"567b28283241c20d00b7305d","ref":"","in":"body","required":false,"desc":"Total duration of the stream chart, from now to this number of seconds in the past.","default":"","type":"int","name":"duration"},{"_id":"567b28283241c20d00b7305c","ref":"","in":"body","required":false,"desc":"Colors to use for the lines","default":"","type":"string","name":"colors"},{"_id":"567b28283241c20d00b7305b","ref":"","in":"body","required":false,"desc":"Either \"none\", \"both\", \"x\", \"y\".  Which axis to display.  Defaults to \"both\"","default":"both","type":"string","name":"axis"}],"url":"/flows/:streamchart_flow_tag/metrics"},"isReference":false,"order":16,"body":"[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/fn565MSiT62A1jcKVCnZ_streamchart.png\",\n        \"streamchart.png\",\n        \"356\",\n        \"204\",\n        \"#94d3d3\",\n        \"\"\n      ]\n    }\n  ]\n}\n[/block]","excerpt":"A stream chart is a sequence of data points rendered as graph. You just send the latest data value to Telemetry server.  Note that this flow type is transient:  the data is from now to the duration seconds in the past.  Additionally the chart will only show the points that it received while the chart is displayed.  Therefore to receive 60 seconds of data you must have the viewer open for 60 seconds.  No data points are stored on the server.","slug":"streamchart","type":"endpoint","title":"Stream Chart"}

postStream Chart

A stream chart is a sequence of data points rendered as graph. You just send the latest data value to Telemetry server. Note that this flow type is transient: the data is from now to the duration seconds in the past. Additionally the chart will only show the points that it received while the chart is displayed. Therefore to receive 60 seconds of data you must have the viewer open for 60 seconds. No data points are stored on the server.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

streamchart_flow_tag:
required
string
The flow tag

Body Params

values:
required
array of doubles
Point in time to render on the chart. Will take up to 6 numbers.
baseline:
stringdynamic
The base of the graph. The default is "dynamic" which means the base is calculated based on it's values. It can also be "zero" which means the base is always 0.
duration:
integer
Total duration of the stream chart, from now to this number of seconds in the past.
colors:
string
Colors to use for the lines
axis:
stringboth
Either "none", "both", "x", "y". Which axis to display. Defaults to "both"

Examples


Result Format


Documentation

[block:image] { "images": [ { "image": [ "https://files.readme.io/fn565MSiT62A1jcKVCnZ_streamchart.png", "streamchart.png", "356", "204", "#94d3d3", "" ] } ] } [/block]

User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}