{"_id":"57fcc4870312b20e00ac6515","user":"54497cce27b7fc140078d9a5","parentDoc":null,"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"},"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","updates":[],"next":{"pages":[],"description":""},"createdAt":"2014-10-31T23:06:58.834Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"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":"","examples":{"codes":[{"name":"Agent Lua","language":"lua","code":"output.icon = \"fa-bolt\"\noutput.label = \"Hello\"\noutput.color = \"#00AAFF\""}]},"method":"post","auth":"required","params":[{"_id":"567b1d6e7c40060d005603fd","ref":"","in":"path","required":true,"desc":"The flow tag","default":"","type":"string","name":"icon_flow_tag"},{"_id":"567b1d6e7c40060d005603fc","ref":"","in":"body","required":true,"desc":"The icon type. Must be the name of an icon from the Font Awesome (http://fortawesome.github.com/Font-Awesome/) library of icons.","default":"","type":"string","name":"icon"},{"_id":"567b1d6e7c40060d005603fb","ref":"","in":"body","required":true,"desc":"The label of the icon.","default":"","type":"string","name":"label"},{"_id":"567b1d6e7c40060d005603fa","ref":"","in":"body","required":true,"desc":"The color of the icon.","default":"","type":"string","name":"color"}],"url":"/flows/:icon_flow_tag/metrics"},"isReference":false,"order":6,"body":"[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Supports Multiple Items\",\n  \"body\": \"Widgets with an icon flow may have multiple items.  You can specify this by containing the below parameters multiple times in an items array.\"\n}\n[/block]\n\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/LrRpE4xRFGgBtubg5IzA_icon.png\",\n        \"icon.png\",\n        \"800\",\n        \"215\",\n        \"#f3f3f3\",\n        \"\"\n      ]\n    }\n  ]\n}\n[/block]","excerpt":"An icon flow is a simple icon display from the Font Awesome set of icons with a color and associated label. Send an array of icons with a type, label and color for each icon. You may submit up to 4 icons in one flow.","slug":"icon","type":"endpoint","title":"Icon"}

postIcon

An icon flow is a simple icon display from the Font Awesome set of icons with a color and associated label. Send an array of icons with a type, label and color for each icon. You may submit up to 4 icons in one flow.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

icon_flow_tag:
required
string
The flow tag

Body Params

icon:
required
string
The icon type. Must be the name of an icon from the Font Awesome (http://fortawesome.github.com/Font-Awesome/) library of icons.
label:
required
string
The label of the icon.
color:
required
string
The color of the icon.

Examples


Result Format


Documentation

[block:callout] { "type": "info", "title": "Supports Multiple Items", "body": "Widgets with an icon flow may have multiple items. You can specify this by containing the below parameters multiple times in an items array." } [/block] [block:image] { "images": [ { "image": [ "https://files.readme.io/LrRpE4xRFGgBtubg5IzA_icon.png", "icon.png", "800", "215", "#f3f3f3", "" ] } ] } [/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 }}