{"_id":"57fcc4870312b20e00ac6506","__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"},"parentDoc":null,"project":"5435687035740020002a1c04","updates":[],"next":{"pages":[],"description":""},"createdAt":"2014-10-24T21:59:43.412Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"never","params":[],"url":""},"isReference":false,"order":5,"body":"A Channel is a pipe where data flows down for a particular board. Boards typically have a single channel, however, for advanced use cases, you may have multiple channels for a single board. This lets you have a singular board layout but have multiple sets of data for the board, each presenting a different data set. Channels are identified in the browser with mutable tags.  \n\n## Channel Object\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Parameter\",\n    \"h-1\": \"Description\",\n    \"0-0\": \"id\",\n    \"0-1\": \"A globally unique static string identifying the object.\",\n    \"1-0\": \"type\",\n    \"1-1\": \"The type of Channel, either 'default', 'affiliated' or 'virtualized'\",\n    \"2-0\": \"name\",\n    \"2-1\": \"A string representing the name of the channel, used to distinguish different virtual channels.\",\n    \"3-0\": \"parent_channel_id\",\n    \"3-1\": \"The id of the channel that a virtual channel based on.\"\n  },\n  \"cols\": 2,\n  \"rows\": 4\n}\n[/block]\n## List Channels\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"GET https://api.telemetrytv.com/channels\",\n  \"body\": \"This method will return a list of all channels on your account.\"\n}\n[/block]\n## Channel Details\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"GET https://api.telemetrytv.com/channels/:id\",\n  \"body\": \"This method will return a specific channel on your account id\"\n}\n[/block]\n## Create a Virtual Channel\n[block:callout]\n{\n  \"type\": \"success\",\n  \"title\": \"POST https://api.telemetrytv.com/channels\",\n  \"body\": \"This method will create a new virtual channel\"\n}\n[/block]\n## Update a Channel\n[block:callout]\n{\n  \"type\": \"warning\",\n  \"title\": \"PATCH https://api.telemetrytv.com/channels/:id\",\n  \"body\": \"This method will update a channel object\"\n}\n[/block]\n## Delete a Channel\n[block:callout]\n{\n  \"type\": \"danger\",\n  \"title\": \"DELETE https://api.telemetrytv.com/channels/:id\",\n  \"body\": \"This method will delete a channel object\"\n}\n[/block]","excerpt":"","slug":"channels","type":"basic","title":"Channels"}
A Channel is a pipe where data flows down for a particular board. Boards typically have a single channel, however, for advanced use cases, you may have multiple channels for a single board. This lets you have a singular board layout but have multiple sets of data for the board, each presenting a different data set. Channels are identified in the browser with mutable tags. ## Channel Object [block:parameters] { "data": { "h-0": "Parameter", "h-1": "Description", "0-0": "id", "0-1": "A globally unique static string identifying the object.", "1-0": "type", "1-1": "The type of Channel, either 'default', 'affiliated' or 'virtualized'", "2-0": "name", "2-1": "A string representing the name of the channel, used to distinguish different virtual channels.", "3-0": "parent_channel_id", "3-1": "The id of the channel that a virtual channel based on." }, "cols": 2, "rows": 4 } [/block] ## List Channels [block:callout] { "type": "info", "title": "GET https://api.telemetrytv.com/channels", "body": "This method will return a list of all channels on your account." } [/block] ## Channel Details [block:callout] { "type": "info", "title": "GET https://api.telemetrytv.com/channels/:id", "body": "This method will return a specific channel on your account id" } [/block] ## Create a Virtual Channel [block:callout] { "type": "success", "title": "POST https://api.telemetrytv.com/channels", "body": "This method will create a new virtual channel" } [/block] ## Update a Channel [block:callout] { "type": "warning", "title": "PATCH https://api.telemetrytv.com/channels/:id", "body": "This method will update a channel object" } [/block] ## Delete a Channel [block:callout] { "type": "danger", "title": "DELETE https://api.telemetrytv.com/channels/:id", "body": "This method will delete a channel object" } [/block]