{"_id":"57fcc4870312b20e00ac6514","project":"5435687035740020002a1c04","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","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,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2014-10-31T23:03:53.653Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"language":"lua","name":"Agent Lua","code":"output.number = {value = 23}\noutput.track = {max = 200}\noutput.label = {text = \"test\"}"}]},"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}"},{"code":"{\n    \"errors\": [\n        \"error description\"\n    ],\n    \"skipped\": [\n    \t\"your_flow_tag\"\n    ],\n    \"updated\": [\n    ]\n}","language":"json","status":400,"name":""}]},"settings":"","auth":"required","params":[{"_id":"567b1c0e4cde0321001e113d","ref":"","in":"path","required":true,"desc":"The flow tag","default":"","type":"string","name":"gauge_flow_tag"},{"_id":"567b1c0e4cde0321001e113c","ref":"","in":"body","required":true,"desc":"The current value of the gauge. This will be shown as a number in the middle and determine the proportion of the max that the gauge fills.","default":"","type":"int","name":"number.value"},{"_id":"567b1c0e4cde0321001e113b","ref":"","in":"body","required":false,"desc":"The type of the number.   Can be \"dollar\", \"pound\", \"euro\", \"percent\", \"fahrenheit\", \"celsius\", \"temperature\" or a text suffix.","default":"","type":"string","name":"number.type"},{"_id":"567b1c0e4cde0321001e113a","ref":"","in":"body","required":false,"desc":"The color of the number","default":"","type":"string","name":"number.color"},{"_id":"567b1c0e4cde0321001e1139","ref":"","in":"body","required":false,"desc":"Whether to abbreviate the number or not","default":"","type":"boolean","name":"number.abbreviate"},{"_id":"567b1c0e4cde0321001e1138","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":"567b1c0e4cde0321001e1137","ref":"","in":"body","required":false,"desc":"The optional color of line for the gauge","default":"","type":"string","name":"track.stroke_color"},{"_id":"567b1c0e4cde0321001e1136","ref":"","in":"body","required":false,"desc":"The optional color of the gauge track background","default":"","type":"string","name":"track.background_color"},{"_id":"567b1c0e4cde0321001e1135","ref":"","in":"body","required":false,"desc":"Defaults to 100 unless set. Do not use when specifying range. This will set the maximum value for the gauge and thus will determine the proportion of the circle currently filled based on the current value.","default":"100","type":"double","name":"track.max"},{"_id":"567b1c0e4cde0321001e1134","ref":"","in":"body","required":false,"desc":"Defaults to 0 unless set. Do not use when specifying range. This will set the minimum value for the gauge and thus will determine the proportion of the circle currently filled based on the current value.","default":"0","type":"double","name":"track.min"},{"_id":"567b1c0e4cde0321001e1133","ref":"","in":"body","required":false,"desc":"This will mark a section of the gauge that values beneath will be designated as a low value and the track will show it accordingly.   It must be higher than the min and lower than the max and lower than the high value.","default":"","type":"double","name":"track.low"},{"_id":"567b1c0e4cde0321001e1132","ref":"","in":"body","required":false,"desc":"This will mark a section of the gauge that values above will be designated as a high value and the track will show it accordingly.   It must be higher than the min and lower than the max and higher than the low value.","default":"","type":"double","name":"track.high"},{"_id":"567b1c0e4cde0321001e1131","ref":"","in":"body","required":false,"desc":"Shows a small marker at this value of the gauge.  Must be higher than the min and lower than the max.","default":"","type":"double","name":"track.marker"},{"_id":"567b1c0e4cde0321001e1130","ref":"","in":"body","required":false,"desc":"Whether to show ticks on the gauge track or not. \"automatic\" or \"hidden\"","default":"automatic","type":"string","name":"track.ticks"},{"_id":"567b1c0e4cde0321001e112f","ref":"","in":"body","required":false,"desc":"The text for the label","default":"","type":"string","name":"label.text"},{"_id":"567b1c0e4cde0321001e112e","ref":"","in":"body","required":false,"desc":"The color of the label","default":"","type":"string","name":"label.color"}],"url":"/flows/:gauge_flow_tag/metrics"},"isReference":false,"order":5,"body":"[block:callout]\n{\n  \"type\": \"info\",\n  \"body\": \"Widgets with an gauge flow may have multiple items.  You can specify this by containing the gauge parameters multiple times in an items array.\",\n  \"title\": \"Supports Multiple Items\"\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Has Different Renderers\",\n  \"body\": \"You can adjust the widget renderers for a Gauge to show it in different styles.\"\n}\n[/block]\n\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/OjQgBSljSoiWjJXWMV6S_radialgauges.png\",\n        \"radialgauges.png\",\n        \"800\",\n        \"215\",\n        \"#4798c1\",\n        \"\"\n      ]\n    }\n  ]\n}\n[/block]\n\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/tnEkFWzlQHmMQ1TikHeC_horizontal-vertical-gauges.png\",\n        \"horizontal-vertical-gauges.png\",\n        \"800\",\n        \"215\",\n        \"#3daad9\",\n        \"\"\n      ]\n    }\n  ]\n}\n[/block]","excerpt":"Gauges show a dial with a superimposed number on them. The dial will be proportional to the current value of the gauge. Send data with a value to represent on the Gauge. The Gauge will display out of a maximum of 100 unless you specify a max amount.","slug":"gauge","type":"endpoint","title":"Gauge"}

postGauge

Gauges show a dial with a superimposed number on them. The dial will be proportional to the current value of the gauge. Send data with a value to represent on the Gauge. The Gauge will display out of a maximum of 100 unless you specify a max amount.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

gauge_flow_tag:
required
string
The flow tag

Body Params

number.value:
required
integer
The current value of the gauge. This will be shown as a number in the middle and determine the proportion of the max that the gauge fills.
number.type:
string
The type of the number. Can be "dollar", "pound", "euro", "percent", "fahrenheit", "celsius", "temperature" or a text suffix.
number.color:
string
The 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.
track.stroke_color:
string
The optional color of line for the gauge
track.background_color:
string
The optional color of the gauge track background
track.max:
double100
Defaults to 100 unless set. Do not use when specifying range. This will set the maximum value for the gauge and thus will determine the proportion of the circle currently filled based on the current value.
track.min:
double0
Defaults to 0 unless set. Do not use when specifying range. This will set the minimum value for the gauge and thus will determine the proportion of the circle currently filled based on the current value.
track.low:
double
This will mark a section of the gauge that values beneath will be designated as a low value and the track will show it accordingly. It must be higher than the min and lower than the max and lower than the high value.
track.high:
double
This will mark a section of the gauge that values above will be designated as a high value and the track will show it accordingly. It must be higher than the min and lower than the max and higher than the low value.
track.marker:
double
Shows a small marker at this value of the gauge. Must be higher than the min and lower than the max.
track.ticks:
stringautomatic
Whether to show ticks on the gauge track or not. "automatic" or "hidden"
label.text:
string
The text for the label
label.color:
string
The color of the label

Examples


Result Format


Documentation

[block:callout] { "type": "info", "body": "Widgets with an gauge flow may have multiple items. You can specify this by containing the gauge parameters multiple times in an items array.", "title": "Supports Multiple Items" } [/block] [block:callout] { "type": "info", "title": "Has Different Renderers", "body": "You can adjust the widget renderers for a Gauge to show it in different styles." } [/block] [block:image] { "images": [ { "image": [ "https://files.readme.io/OjQgBSljSoiWjJXWMV6S_radialgauges.png", "radialgauges.png", "800", "215", "#4798c1", "" ] } ] } [/block] [block:image] { "images": [ { "image": [ "https://files.readme.io/tnEkFWzlQHmMQ1TikHeC_horizontal-vertical-gauges.png", "horizontal-vertical-gauges.png", "800", "215", "#3daad9", "" ] } ] } [/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 }}