{"_id":"57fcc4870312b20e00ac6519","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"},"parentDoc":null,"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,"project":"5435687035740020002a1c04","user":"5435682035740020002a1c01","updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-05-01T21:42:17.735Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"code":"output.series = array({\n  {values = array({1,2,3,4,5,6,7,8,9,10})}\n})\noutput.value_type = \"dollar\"\noutput.baseline = \"zero\"","language":"lua","name":"Agent Lua"}]},"method":"post","results":{"codes":[{"language":"json","status":200,"name":"","code":"{\n    \"errors\": [\n    ],\n    \"skipped\": [\n    ],\n    \"updated\": [\n    \t\"your_flow_tag\"\n    ]\n}"},{"name":"","code":"{\n    \"errors\": [\n        \"error description\"\n    ],\n    \"skipped\": [\n    \t\"your_flow_tag\"\n    ],\n    \"updated\": [\n    ]\n}","language":"json","status":400}]},"settings":"","auth":"required","params":[{"_id":"567b204817368a0d009a6e2c","ref":"","in":"path","required":true,"desc":"The flow tag","default":"","type":"string","name":"linechart_flow_tag"},{"_id":"567b204817368a0d009a6e2b","ref":"","in":"body","required":true,"desc":"See the Series object below","default":"","type":"array_object","name":"series"},{"_id":"567b204817368a0d009a6e2a","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":"567b204817368a0d009a6e29","ref":"","in":"body","required":false,"desc":"\"Start Time\" and \"End Time\" can be used to automatically calculate the x labels. \"End Time\" is optional, when it is blank, it means now. \"Start Time\" takes precedence over x_labels.","default":"","type":"timestamp","name":"start_time"},{"_id":"567b204817368a0d009a6e28","ref":"","in":"body","required":false,"desc":"\"Start Time\" and \"End Time\" can be used to automatically calculate the x labels. \"End Time\" is optional, when it is blank, it means now.","default":"","type":"timestamp","name":"end_time"},{"_id":"567b204817368a0d009a6e27","ref":"","in":"body","required":false,"desc":"When one or more series has incomplete data, it tells whether to crop the line on the right or left or to fill the missing data with '0' to the right.","default":"","type":"string","name":"missing_data"},{"_id":"567b204817368a0d009a6e26","ref":"","in":"body","required":false,"desc":"The optional minimum scale of the graph. If unset the graph will be rendered with the highest value at the top. This can be set to normalize multiple graphs to the same maximum value. If the graph exceeds this amount the graph will use the highest value instead of the min_scale.","default":"","type":"double","name":"min_scale"},{"_id":"567b204817368a0d009a6e25","ref":"","in":"body","required":false,"desc":"The type of value, can be \"dollar\", \"pound\", \"euro\", \"percent\", \"fahrenheit\", \"celsius\", \"temperature\" or a text suffix.","default":"","type":"string","name":"value_type"},{"_id":"567b204817368a0d009a6e24","ref":"","in":"body","required":false,"desc":"Control whether to hide y axis labels. Selecting \"none\" will make y axis label to never be shown. It defaults to \"auto\".","default":"","type":"array_string","name":"x_labels"},{"_id":"567b204817368a0d009a6e23","ref":"","in":"body","required":false,"desc":"Control whether to hide y axis labels. Selecting \"none\" will make y axis label to never be shown. It defaults to \"auto\".","default":"auto","type":"string","name":"y_labels"}],"url":"/flows/:linechart_flow_tag/metrics"},"isReference":false,"order":10,"body":"[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Series Parameters\",\n    \"h-1\": \"Required\",\n    \"h-2\": \"Type\",\n    \"h-3\": \"Description\",\n    \"0-0\": \"values\",\n    \"1-0\": \"color\",\n    \"2-0\": \"label\",\n    \"0-1\": \"required\",\n    \"0-2\": \"array of numbers\",\n    \"1-2\": \"CSS color\",\n    \"2-2\": \"string\",\n    \"0-3\": \"An array of numbers. Each number will be charted from left to right on the graph in order.\",\n    \"2-3\": \"A label for the graph's line.\",\n    \"1-3\": \"The color of the graph's line.\",\n    \"3-0\": \"series_type\",\n    \"3-2\": \"string, one of: \\\"line\\\", \\\"spline\\\",  \\\"area\\\", \\\"scatter\\\", \\\"bar\\\",  \\\"stacked bar\\\".\",\n    \"3-3\": \"overrides the renderer for this line. Lets you mix multiple types of lines in a single graph.   Note that horizontal bar isn't supported in this or as the base renderer.\"\n  },\n  \"cols\": 4,\n  \"rows\": 4\n}\n[/block]\n\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/DWtyVpvyTgaLObMXDzCT_linechart-1.png\",\n        \"linechart-1.png\",\n        \"800\",\n        \"217\",\n        \"#46b2b0\",\n        \"\"\n      ]\n    }\n  ]\n}\n[/block]\n\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/ZXcuCGHTJ6vmuzQMwfmw_linechart-3b.png\",\n        \"linechart-3b.png\",\n        \"800\",\n        \"217\",\n        \"#1ab5af\",\n        \"\"\n      ]\n    }\n  ]\n}\n[/block]\n\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/Ej6zDDLfTOStHd8jg1bw_linechart-2.png\",\n        \"linechart-2.png\",\n        \"800\",\n        \"217\",\n        \"#36b8ae\",\n        \"\"\n      ]\n    }\n  ]\n}\n[/block]","excerpt":"A Line Chart displays a line chart.","slug":"linechart","type":"endpoint","title":"Line Chart"}

postLine Chart

A Line Chart displays a line chart.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

linechart_flow_tag:
required
string
The flow tag

Body Params

series:
required
array of objects
See the Series object below
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.
start_time:
timestamp
"Start Time" and "End Time" can be used to automatically calculate the x labels. "End Time" is optional, when it is blank, it means now. "Start Time" takes precedence over x_labels.
end_time:
timestamp
"Start Time" and "End Time" can be used to automatically calculate the x labels. "End Time" is optional, when it is blank, it means now.
missing_data:
string
When one or more series has incomplete data, it tells whether to crop the line on the right or left or to fill the missing data with '0' to the right.
min_scale:
double
The optional minimum scale of the graph. If unset the graph will be rendered with the highest value at the top. This can be set to normalize multiple graphs to the same maximum value. If the graph exceeds this amount the graph will use the highest value instead of the min_scale.
value_type:
string
The type of value, can be "dollar", "pound", "euro", "percent", "fahrenheit", "celsius", "temperature" or a text suffix.
x_labels:
array of strings
Control whether to hide y axis labels. Selecting "none" will make y axis label to never be shown. It defaults to "auto".
y_labels:
stringauto
Control whether to hide y axis labels. Selecting "none" will make y axis label to never be shown. It defaults to "auto".

Examples


Result Format


Documentation

[block:parameters] { "data": { "h-0": "Series Parameters", "h-1": "Required", "h-2": "Type", "h-3": "Description", "0-0": "values", "1-0": "color", "2-0": "label", "0-1": "required", "0-2": "array of numbers", "1-2": "CSS color", "2-2": "string", "0-3": "An array of numbers. Each number will be charted from left to right on the graph in order.", "2-3": "A label for the graph's line.", "1-3": "The color of the graph's line.", "3-0": "series_type", "3-2": "string, one of: \"line\", \"spline\", \"area\", \"scatter\", \"bar\", \"stacked bar\".", "3-3": "overrides the renderer for this line. Lets you mix multiple types of lines in a single graph. Note that horizontal bar isn't supported in this or as the base renderer." }, "cols": 4, "rows": 4 } [/block] [block:image] { "images": [ { "image": [ "https://files.readme.io/DWtyVpvyTgaLObMXDzCT_linechart-1.png", "linechart-1.png", "800", "217", "#46b2b0", "" ] } ] } [/block] [block:image] { "images": [ { "image": [ "https://files.readme.io/ZXcuCGHTJ6vmuzQMwfmw_linechart-3b.png", "linechart-3b.png", "800", "217", "#1ab5af", "" ] } ] } [/block] [block:image] { "images": [ { "image": [ "https://files.readme.io/Ej6zDDLfTOStHd8jg1bw_linechart-2.png", "linechart-2.png", "800", "217", "#36b8ae", "" ] } ] } [/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 }}