{"_id":"57fcc4870312b20e00ac650e","parentDoc":null,"__v":0,"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"},"category":{"_id":"57fcc4860312b20e00ac64cb","__v":0,"version":"57fcc4860312b20e00ac64c0","project":"5435687035740020002a1c04","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2014-10-24T21:45:44.150Z","from_sync":false,"order":10,"slug":"api-methods","title":"API Methods"},"project":"5435687035740020002a1c04","updates":[],"next":{"pages":[],"description":""},"createdAt":"2014-10-24T22:03:39.663Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"never","params":[],"url":""},"isReference":false,"order":20,"body":"Widgets are mostly hidden from the Telemetry web interface however they're critical elements to position flows within a board.\n\nNote that the widget isn't where the metrics live,  metrics are contained by [Flows](doc:flows)  and are represented by the [Metrics](doc:metrics) endpoint.\n\n## Widget Object\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Parameter\",\n    \"h-1\": \"Description\",\n    \"0-0\": \"id\",\n    \"1-0\": \"board_id\",\n    \"2-0\": \"variant\",\n    \"3-0\": \"column\",\n    \"4-0\": \"row\",\n    \"5-0\": \"width\",\n    \"6-0\": \"height\",\n    \"7-0\": \"in_board_index\",\n    \"8-0\": \"background\",\n    \"0-1\": \"A globally unique static string identifying the object.\",\n    \"1-1\": \"A globally unique static string identifying the board that the widget belongs to.\",\n    \"2-1\": \"The variant of the widget: barchart, box, bulletchart, clock, compass, countdown, funnelchart, gauge, graph, grid, icon, iframe, image, log, map, multigauge, multivalue, piechart, scatterplot, servers, status, table, text, tickertape, timeline, timeseries, upstatus, value, video, waterfall, weather.\",\n    \"3-1\": \"The column of the top left of the widget on a board.\",\n    \"4-1\": \"The row of the top left of the widget on a board.\",\n    \"5-1\": \"The width of a widget in columns.\",\n    \"6-1\": \"The height of a widget in rows.\",\n    \"7-1\": \"The layer sorting order of the widget within the board.\",\n    \"8-1\": \"The background color of the widget. Possible values are: \\n\\\"default\\\" => The background will be dark/light depends on the selected theme of the board \\n\\\"none\\\" => Transparent background \\nHex code (e.g. #09ab3f) => Hex code of a color.\",\n    \"9-0\": \"renderer\",\n    \"9-1\": \"An optional parameter that specifies a specific renderer to use.  Things like changing a line chart from a spline to an area.  See the renderer options below.\",\n    \"10-0\": \"title\",\n    \"10-1\": \"A title string to display at the top of the widget.\"\n  },\n  \"cols\": 2,\n  \"rows\": 11\n}\n[/block]\n## List all Widgets\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"GET https://api.telemetrytv.com/widgets\",\n  \"body\": \"This method will return a list of all widgets on your account.\"\n}\n[/block]\n## Display a Widget\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"GET https://api.telemetrytv.com/widgets/:id\",\n  \"body\": \"This method will return a specific widget on your account by id. It also returns an array of flows for the default channel of the board. There's an optional channel_id parameter to return the flows for that channel instead of the default.\"\n}\n[/block]\n## Create a Widget\n[block:callout]\n{\n  \"type\": \"success\",\n  \"title\": \"POST https://api.telemetrytv.com/widgets\",\n  \"body\": \"This method will create a new widget.\"\n}\n[/block]\n## Update a Widget\n[block:callout]\n{\n  \"type\": \"warning\",\n  \"title\": \"PATCH https://api.telemetrytv.com/widgets/:id\",\n  \"body\": \"This method will update a widget object.\"\n}\n[/block]\n## Delete a Widget\n[block:callout]\n{\n  \"type\": \"danger\",\n  \"title\": \"DELETE https://api.telemetrytv.com/widgets/:id\",\n  \"body\": \"This method will delete a widget object.\"\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Widget Renderer Options\"\n}\n[/block]\nDifferent widgets have different rendering options.  Not all widget variants have rendering options.  This is optional and each widget that supports renderer options has a default renderer. \n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Variant\",\n    \"h-1\": \"Options\",\n    \"0-0\": \"compass\",\n    \"0-1\": \"gauge, heading\",\n    \"1-0\": \"gauge\",\n    \"1-1\": \"circle, combined, vertical, horizontal\",\n    \"2-0\": \"linechart\",\n    \"2-1\": \"line, spline, area, bar, scatter\",\n    \"3-0\": \"number\",\n    \"4-0\": \"sparkline\",\n    \"5-0\": \"timeseries\",\n    \"5-1\": \"line, spline, area, bar, scatter\",\n    \"4-1\": \"spline, line, bar, area\",\n    \"3-1\": \"equal, number, label, icon\",\n    \"6-0\": \"piechart\",\n    \"6-1\": \"donut, pie\"\n  },\n  \"cols\": 2,\n  \"rows\": 7\n}\n[/block]","excerpt":"","slug":"widgets","type":"basic","title":"Widgets"}
Widgets are mostly hidden from the Telemetry web interface however they're critical elements to position flows within a board. Note that the widget isn't where the metrics live, metrics are contained by [Flows](doc:flows) and are represented by the [Metrics](doc:metrics) endpoint. ## Widget Object [block:parameters] { "data": { "h-0": "Parameter", "h-1": "Description", "0-0": "id", "1-0": "board_id", "2-0": "variant", "3-0": "column", "4-0": "row", "5-0": "width", "6-0": "height", "7-0": "in_board_index", "8-0": "background", "0-1": "A globally unique static string identifying the object.", "1-1": "A globally unique static string identifying the board that the widget belongs to.", "2-1": "The variant of the widget: barchart, box, bulletchart, clock, compass, countdown, funnelchart, gauge, graph, grid, icon, iframe, image, log, map, multigauge, multivalue, piechart, scatterplot, servers, status, table, text, tickertape, timeline, timeseries, upstatus, value, video, waterfall, weather.", "3-1": "The column of the top left of the widget on a board.", "4-1": "The row of the top left of the widget on a board.", "5-1": "The width of a widget in columns.", "6-1": "The height of a widget in rows.", "7-1": "The layer sorting order of the widget within the board.", "8-1": "The background color of the widget. Possible values are: \n\"default\" => The background will be dark/light depends on the selected theme of the board \n\"none\" => Transparent background \nHex code (e.g. #09ab3f) => Hex code of a color.", "9-0": "renderer", "9-1": "An optional parameter that specifies a specific renderer to use. Things like changing a line chart from a spline to an area. See the renderer options below.", "10-0": "title", "10-1": "A title string to display at the top of the widget." }, "cols": 2, "rows": 11 } [/block] ## List all Widgets [block:callout] { "type": "info", "title": "GET https://api.telemetrytv.com/widgets", "body": "This method will return a list of all widgets on your account." } [/block] ## Display a Widget [block:callout] { "type": "info", "title": "GET https://api.telemetrytv.com/widgets/:id", "body": "This method will return a specific widget on your account by id. It also returns an array of flows for the default channel of the board. There's an optional channel_id parameter to return the flows for that channel instead of the default." } [/block] ## Create a Widget [block:callout] { "type": "success", "title": "POST https://api.telemetrytv.com/widgets", "body": "This method will create a new widget." } [/block] ## Update a Widget [block:callout] { "type": "warning", "title": "PATCH https://api.telemetrytv.com/widgets/:id", "body": "This method will update a widget object." } [/block] ## Delete a Widget [block:callout] { "type": "danger", "title": "DELETE https://api.telemetrytv.com/widgets/:id", "body": "This method will delete a widget object." } [/block] [block:api-header] { "type": "basic", "title": "Widget Renderer Options" } [/block] Different widgets have different rendering options. Not all widget variants have rendering options. This is optional and each widget that supports renderer options has a default renderer. [block:parameters] { "data": { "h-0": "Variant", "h-1": "Options", "0-0": "compass", "0-1": "gauge, heading", "1-0": "gauge", "1-1": "circle, combined, vertical, horizontal", "2-0": "linechart", "2-1": "line, spline, area, bar, scatter", "3-0": "number", "4-0": "sparkline", "5-0": "timeseries", "5-1": "line, spline, area, bar, scatter", "4-1": "spline, line, bar, area", "3-1": "equal, number, label, icon", "6-0": "piechart", "6-1": "donut, pie" }, "cols": 2, "rows": 7 } [/block]