{"_id":"57fcc4870312b20e00ac6526","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","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"},"parentDoc":null,"__v":0,"project":"5435687035740020002a1c04","updates":[],"next":{"pages":[],"description":""},"createdAt":"2014-10-31T23:15:22.220Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"name":"Agent Lua","code":"output.data = array({\n  {serial = 1431102409, values = array({34,234,654,23,67,34})}\n})","language":"lua"}]},"method":"post","results":{"codes":[{"status":200,"language":"json","code":"{\n    \"errors\": [\n    ],\n    \"skipped\": [\n    ],\n    \"updated\": [\n    \t\"your_flow_tag\"\n    ]\n}","name":""},{"status":400,"language":"json","code":"{\n    \"errors\": [\n        \"error description\"\n    ],\n    \"skipped\": [\n    \t\"your_flow_tag\"\n    ],\n    \"updated\": [\n    ]\n}","name":""}]},"settings":"","auth":"required","params":[{"_id":"5682da35eb6f4c0d00e89df7","ref":"","in":"path","required":true,"desc":"The flow tag","default":"","type":"string","name":"waterfall_flow_tag"},{"_id":"5682da35eb6f4c0d00e89df6","ref":"","in":"body","required":true,"desc":"Array of items, see below.","default":"","type":"array_object","name":"data"},{"_id":"5682da8b6d21130d00a705e1","ref":"","in":"body","required":false,"desc":"CSS color of the items","default":"","type":"string","name":"color"},{"_id":"5682da8b6d21130d00a705e0","ref":"","in":"body","required":false,"desc":"The direction to which the numbers move. One of: \"up\", \"down\", \"left\", \"right\"","default":"","type":"string","name":"direction"},{"_id":"5682db8270331a0d00484a2b","ref":"","in":"body","required":false,"desc":"Indication of how fast the numbers move. Minimum of 1.","default":"","type":"int","name":"spread"},{"_id":"5682db8270331a0d00484a2a","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"}],"url":"/flows/:waterfall_flow_tag/metrics"},"isReference":false,"order":23,"body":"[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Data Object Parameter\",\n    \"h-1\": \"Required\",\n    \"h-2\": \"Type\",\n    \"h-3\": \"Description\",\n    \"0-0\": \"serial\",\n    \"0-1\": \"required\",\n    \"0-2\": \"number, min = 1\",\n    \"0-3\": \"An index or serial number so that the same series of numbers would not be displayed twice.\",\n    \"1-3\": \"An array of values to display.\",\n    \"1-2\": \"string, array of numbers, max items = 255\",\n    \"1-1\": \"required\",\n    \"1-0\": \"values\"\n  },\n  \"cols\": 4,\n  \"rows\": 2\n}\n[/block]\n\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/XJnvTF57S4WPerd3doVn_waterfall.png\",\n        \"waterfall.png\",\n        \"800\",\n        \"215\",\n        \"#f3f3f3\",\n        \"\"\n      ]\n    }\n  ]\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Example\"\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"data\\\": [\\n        {\\n            \\\"serial\\\": 1431102409,\\n            \\\"values\\\": [\\n                12,\\n                321,\\n                32,\\n                124,\\n                234,\\n                32\\n            ]\\n        }\\n    ]\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]","excerpt":"Waterfall data flow displays the values fall from above, like a waterfall.","slug":"waterfall","type":"endpoint","title":"Waterfall"}

postWaterfall

Waterfall data flow displays the values fall from above, like a waterfall.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

waterfall_flow_tag:
required
string
The flow tag

Body Params

data:
required
array of objects
Array of items, see below.
color:
string
CSS color of the items
direction:
string
The direction to which the numbers move. One of: "up", "down", "left", "right"
spread:
integer
Indication of how fast the numbers move. Minimum of 1.
value_type:
string
The type of value, can be "dollar", "pound", "euro", "percent", "fahrenheit", "celsius", "temperature" or a text suffix.

Examples


Result Format


Documentation

[block:parameters] { "data": { "h-0": "Data Object Parameter", "h-1": "Required", "h-2": "Type", "h-3": "Description", "0-0": "serial", "0-1": "required", "0-2": "number, min = 1", "0-3": "An index or serial number so that the same series of numbers would not be displayed twice.", "1-3": "An array of values to display.", "1-2": "string, array of numbers, max items = 255", "1-1": "required", "1-0": "values" }, "cols": 4, "rows": 2 } [/block] [block:image] { "images": [ { "image": [ "https://files.readme.io/XJnvTF57S4WPerd3doVn_waterfall.png", "waterfall.png", "800", "215", "#f3f3f3", "" ] } ] } [/block] [block:api-header] { "type": "basic", "title": "Example" } [/block] [block:code] { "codes": [ { "code": "{\n \"data\": [\n {\n \"serial\": 1431102409,\n \"values\": [\n 12,\n 321,\n 32,\n 124,\n 234,\n 32\n ]\n }\n ]\n}", "language": "json" } ] } [/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 }}