{"_id":"57fcc4870312b20e00ac651c","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":"5435682035740020002a1c01","__v":0,"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"},"project":"5435687035740020002a1c04","updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-05-01T21:42:31.543Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"code":"output.number = {value = 23}\noutput.label = {}\noutput.label.text = \"Hello\"\noutput.label.color = \"green\"","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}]},"settings":"","auth":"required","params":[{"_id":"567b258f4cde0321001e1156","ref":"","in":"path","required":true,"desc":"The flow tag","default":"","type":"string","name":"number_flow_tag"},{"_id":"567b258f4cde0321001e1155","ref":"","in":"body","required":true,"desc":"The value of the number","default":"","type":"double","name":"number.value"},{"_id":"567b258f4cde0321001e1154","ref":"","in":"body","required":false,"desc":"Type type of the number. Can be \"dollar\", \"pound\", \"euro\", \"percent\", \"fahrenheit\", \"celsius\", \"temperature\" or a text suffix.","default":"","type":"string","name":"number.type"},{"_id":"567b258f4cde0321001e1153","ref":"","in":"body","required":false,"desc":"The CSS color of the number","default":"","type":"string","name":"number.color"},{"_id":"567b258f4cde0321001e1152","ref":"","in":"body","required":false,"desc":"Whether to abbreviate the number or not.","default":"","type":"boolean","name":"number.abbreviate"},{"_id":"567b258f4cde0321001e1151","ref":"","in":"body","required":false,"desc":"The number of digits to round to.  0 to round to the nearest integer.","default":"","type":"int","name":"number.rounding"},{"_id":"567b258f4cde0321001e1150","ref":"","in":"body","required":false,"desc":"A text label to show under the value. Keep it short so it will fit nicely.","default":"","type":"string","name":"label.text"},{"_id":"567b258f4cde0321001e114f","ref":"","in":"body","required":false,"desc":"The css color of the label","default":"","type":"string","name":"label.color"},{"_id":"567b258f4cde0321001e114e","ref":"","in":"body","required":false,"desc":"Font Awesome (http://fortawesome.github.com/Font-Awesome/) library of icons ie. 'fa-eye'","default":"","type":"string","name":"icon.name"},{"_id":"567b258f4cde0321001e114d","ref":"","in":"body","required":false,"desc":"The CSS color of the label","default":"","type":"string","name":"icon.color"}],"url":"/flows/:number_flow_tag/metrics"},"isReference":false,"order":13,"body":"[block:callout]\n{\n  \"type\": \"info\",\n  \"body\": \"Widgets with an number flow may have multiple items.  You can specify this by containing the below parameters multiple times in an items[] array.\",\n  \"title\": \"Supports Multiple Items\"\n}\n[/block]\n\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/jiHga65S7OwXiommdBnt_number-1.png\",\n        \"number-1.png\",\n        \"800\",\n        \"215\",\n        \"#927062\",\n        \"\"\n      ]\n    }\n  ]\n}\n[/block]\n\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/ysDJ8liDR1i7aKIbjEKH_number-2.png\",\n        \"number-2.png\",\n        \"800\",\n        \"215\",\n        \"#a08475\",\n        \"\"\n      ]\n    }\n  ]\n}\n[/block]","excerpt":"A number flow shows a number with an optional label and icon.","slug":"number","type":"endpoint","title":"Number"}

postNumber

A number flow shows a number with an optional label and icon.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

number_flow_tag:
required
string
The flow tag

Body Params

number.value:
required
double
The value of the number
number.type:
string
Type type of the number. Can be "dollar", "pound", "euro", "percent", "fahrenheit", "celsius", "temperature" or a text suffix.
number.color:
string
The CSS color of the number
number.abbreviate:
boolean
Whether to abbreviate the number or not.
number.rounding:
integer
The number of digits to round to. 0 to round to the nearest integer.
label.text:
string
A text label to show under the value. Keep it short so it will fit nicely.
label.color:
string
The css color of the label
icon.name:
string
Font Awesome (http://fortawesome.github.com/Font-Awesome/) library of icons ie. 'fa-eye'
icon.color:
string
The CSS color of the label

Examples


Result Format


Documentation

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