{"_id":"57fcc4870312b20e00ac6513","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,"project":"5435687035740020002a1c04","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"},"user":"54497cce27b7fc140078d9a5","__v":0,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2014-10-31T23:03:34.850Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"method":"post","results":{"codes":[{"code":"{\n    \"errors\": [\n    ],\n    \"skipped\": [\n    ],\n    \"updated\": [\n    \t\"your_flow_tag\"\n    ]\n}","language":"json","status":200,"name":""},{"status":400,"name":"","code":"{\n    \"errors\": [\n        \"error description\"\n    ],\n    \"skipped\": [\n    \t\"your_flow_tag\"\n    ],\n    \"updated\": [\n    ]\n}","language":"json"}]},"settings":"","examples":{"codes":[{"code":"output.values = array({\n  {value = 10, label = \"alpha\"},    \n  {value = 20, label = \"bravo\"},    \n  {value = 30, label = \"charlie\"}    \n})","language":"lua","name":"Agent Lua"}]},"auth":"never","params":[{"_id":"567b19aa3241c20d00b7304a","ref":"","in":"body","required":true,"desc":"An array of value objects, see below.","default":"","type":"array_object","name":"values"},{"_id":"567b19aa3241c20d00b73049","ref":"","in":"body","required":false,"desc":"The default \"auto\" places the label on the inside or outside depending on the width and height of the widget container. Option \"inside\" places label within the funnelchart. Option \"outside\" places label outside the funnelchart.","default":"auto","type":"string","name":"label_position"}],"url":"/flows/:funnelchart_flow_tag/metrics"},"isReference":false,"order":4,"body":"[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Values Object Parameter\",\n    \"h-1\": \"Required\",\n    \"h-2\": \"Type\",\n    \"h-3\": \"Description\",\n    \"1-0\": \"label\",\n    \"2-0\": \"value\",\n    \"2-1\": \"Required\",\n    \"1-1\": \"Required\",\n    \"1-2\": \"string\",\n    \"2-2\": \"number, min = 0\",\n    \"1-3\": \"The label of the sector.\",\n    \"2-3\": \"The value used to determine the area of the sector.\",\n    \"0-0\": \"color\",\n    \"0-2\": \"CSS color\",\n    \"0-3\": \"The color of the area of the sector.\"\n  },\n  \"cols\": 4,\n  \"rows\": 3\n}\n[/block]\n\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/oG5NG6TuTc6XuR4GOOeW_funnelchart.png\",\n        \"funnelchart.png\",\n        \"800\",\n        \"217\",\n        \"#48ade4\",\n        \"\"\n      ],\n      \"caption\": \"\"\n    }\n  ]\n}\n[/block]","excerpt":"A funnel chart displays values as progressively decreasing proportions. The height of each section is determined by the series value as a percentage of the total of all values.","slug":"funnelchart","type":"endpoint","title":"Funnel Chart"}

postFunnel Chart

A funnel chart displays values as progressively decreasing proportions. The height of each section is determined by the series value as a percentage of the total of all values.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Body Params

values:
required
array of objects
An array of value objects, see below.
label_position:
stringauto
The default "auto" places the label on the inside or outside depending on the width and height of the widget container. Option "inside" places label within the funnelchart. Option "outside" places label outside the funnelchart.

Examples


Result Format


Documentation

[block:parameters] { "data": { "h-0": "Values Object Parameter", "h-1": "Required", "h-2": "Type", "h-3": "Description", "1-0": "label", "2-0": "value", "2-1": "Required", "1-1": "Required", "1-2": "string", "2-2": "number, min = 0", "1-3": "The label of the sector.", "2-3": "The value used to determine the area of the sector.", "0-0": "color", "0-2": "CSS color", "0-3": "The color of the area of the sector." }, "cols": 4, "rows": 3 } [/block] [block:image] { "images": [ { "image": [ "https://files.readme.io/oG5NG6TuTc6XuR4GOOeW_funnelchart.png", "funnelchart.png", "800", "217", "#48ade4", "" ], "caption": "" } ] } [/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 }}