{"_id":"57fcc4870312b20e00ac6508","parentDoc":null,"project":"5435687035740020002a1c04","__v":0,"user":"54497cce27b7fc140078d9a5","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"},"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"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2014-10-24T22:01:16.891Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"never","params":[],"url":""},"isReference":false,"order":9,"body":"Flows are objects that represent the container for metrics for a particular type of widget.  Flows can exist individually or may be displayed together on a board. When embedded within a board they are positioned with widgets. Flows are grouped together within channel objects.\n\nFor the actual values of the metrics, you'll want the [Metrics](doc:metrics) endpoint.\n\n## Flow Object\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Parameter\",\n    \"h-1\": \"Type\",\n    \"0-0\": \"id\",\n    \"1-0\": \"type\",\n    \"2-0\": \"variant\",\n    \"3-0\": \"tag\",\n    \"4-0\": \"errored\",\n    \"0-1\": \"string\",\n    \"1-1\": \"One of 'default', 'affiliated', or 'virtualized'.\",\n    \"2-1\": \"string\",\n    \"3-1\": \"string\",\n    \"4-1\": \"boolean\",\n    \"h-2\": \"Description\",\n    \"0-2\": \"A globally unique static string identifying the object.\",\n    \"1-2\": \"The type of flow.\",\n    \"2-2\": \"The variant of the flow.\",\n    \"3-2\": \"The tag for the flow, a human readable identifier unique to your account.\",\n    \"4-2\": \"If set to true then the widget will show an error icon. Typically this is set automatically by the agent when a related script returns an error.\"\n  },\n  \"cols\": 3,\n  \"rows\": 5\n}\n[/block]\n## Flow Listing\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"GET https://api.telemetrytv.com/flows\",\n  \"body\": \"This method will return a list of all flows on your account.\"\n}\n[/block]\n## Flow Details\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"GET https://api.telemetrytv.com/flows/:id\",\n  \"body\": \"This method will return a specific flow on your account by id.\"\n}\n[/block]\n## Create a Flow\n[block:callout]\n{\n  \"type\": \"success\",\n  \"title\": \"POST https://api.telemetrytv.com/flows\",\n  \"body\": \"This method will create a new flow. It will be enabled when it is ready (for flows that require a source and parameters to be set, this is when the source and parameters are set, for other flows, it is right away).\"\n}\n[/block]\n## Update a Flow\n[block:callout]\n{\n  \"type\": \"warning\",\n  \"title\": \"PATCH https://api.telemetrytv.com/flows/:id\",\n  \"body\": \"This method will update a flow object.\"\n}\n[/block]\n## Delete a Flow\n[block:callout]\n{\n  \"type\": \"danger\",\n  \"title\": \"DELETE https://api.telemetrytv.com/flows/:id\",\n  \"body\": \"This method will delete a flow object.\"\n}\n[/block]","excerpt":"","slug":"flows","type":"basic","title":"Flows"}
Flows are objects that represent the container for metrics for a particular type of widget. Flows can exist individually or may be displayed together on a board. When embedded within a board they are positioned with widgets. Flows are grouped together within channel objects. For the actual values of the metrics, you'll want the [Metrics](doc:metrics) endpoint. ## Flow Object [block:parameters] { "data": { "h-0": "Parameter", "h-1": "Type", "0-0": "id", "1-0": "type", "2-0": "variant", "3-0": "tag", "4-0": "errored", "0-1": "string", "1-1": "One of 'default', 'affiliated', or 'virtualized'.", "2-1": "string", "3-1": "string", "4-1": "boolean", "h-2": "Description", "0-2": "A globally unique static string identifying the object.", "1-2": "The type of flow.", "2-2": "The variant of the flow.", "3-2": "The tag for the flow, a human readable identifier unique to your account.", "4-2": "If set to true then the widget will show an error icon. Typically this is set automatically by the agent when a related script returns an error." }, "cols": 3, "rows": 5 } [/block] ## Flow Listing [block:callout] { "type": "info", "title": "GET https://api.telemetrytv.com/flows", "body": "This method will return a list of all flows on your account." } [/block] ## Flow Details [block:callout] { "type": "info", "title": "GET https://api.telemetrytv.com/flows/:id", "body": "This method will return a specific flow on your account by id." } [/block] ## Create a Flow [block:callout] { "type": "success", "title": "POST https://api.telemetrytv.com/flows", "body": "This method will create a new flow. It will be enabled when it is ready (for flows that require a source and parameters to be set, this is when the source and parameters are set, for other flows, it is right away)." } [/block] ## Update a Flow [block:callout] { "type": "warning", "title": "PATCH https://api.telemetrytv.com/flows/:id", "body": "This method will update a flow object." } [/block] ## Delete a Flow [block:callout] { "type": "danger", "title": "DELETE https://api.telemetrytv.com/flows/:id", "body": "This method will delete a flow object." } [/block]