{"_id":"57fcc4870312b20e00ac6505","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"},"__v":0,"parentDoc":null,"project":"5435687035740020002a1c04","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"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2014-10-24T21:59:24.463Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"never","params":[],"url":""},"isReference":false,"order":4,"body":"The boards object represent the boards (dashboards) within your account. Boards are collections of widgets and their flows contained together for display.  \n\n## Board Object\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Parameter\",\n    \"h-1\": \"Description\",\n    \"0-0\": \"id\",\n    \"1-0\": \"name\",\n    \"2-0\": \"theme\",\n    \"3-0\": \"columns\",\n    \"4-0\": \"rows\",\n    \"5-0\": \"size\",\n    \"6-0\": \"aspect_ratio\",\n    \"7-0\": \"display_board_name\",\n    \"8-0\": \"widget_margins\",\n    \"9-0\": \"widget_padding\",\n    \"10-0\": \"font_size\",\n    \"11-0\": \"font_family\",\n    \"0-1\": \"A globally unique static string identifying the object.\",\n    \"1-1\": \"The name of the board.\",\n    \"2-1\": \"The theme for the board.\",\n    \"3-1\": \"The number of columns in the board grid.\",\n    \"4-1\": \"The number of rows in the board grid.\",\n    \"5-1\": \"An array representing the native size of the board.\",\n    \"6-1\": \"A string with the aspect ratio of the board.\",\n    \"7-1\": \"Whether to show the board name at the top of the board or not.\",\n    \"8-1\": \"The external margin of a widget, defaults to 3.\",\n    \"9-1\": \"The internal padding of a widget, defaults to 8.\",\n    \"10-1\": \"The size of the font to use, can be 'small', 'normal' or 'large'.\",\n    \"11-1\": \"The font family to use, defaults to 'normal' which uses the theme default.\",\n    \"12-0\": \"background_color\",\n    \"12-1\": \"The background color of the board.\",\n    \"13-0\": \"background_url\",\n    \"13-1\": \"The background image URL of the board.\",\n    \"14-0\": \"widget_color\",\n    \"14-1\": \"The background color of the widgets.\",\n    \"15-0\": \"widget_title_color\",\n    \"15-1\": \"The color of the widgets' titles.\",\n    \"16-0\": \"widget_title_size\",\n    \"16-1\": \"The size of the widgets' titles.\"\n  },\n  \"cols\": 2,\n  \"rows\": 17\n}\n[/block]\n## Boards Listing\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"GET https://api.telemetrytv.com/boards\",\n  \"body\": \"This method will return a list of all boards on your account.\"\n}\n[/block]\n## Board Details\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"GET https://api.telemetrytv.com/boards/:id\",\n  \"body\": \"This method will return a specific board on your account by id.\"\n}\n[/block]\n## Export Board\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"GET https://api.telemetrytv.com/boards/:id/export\",\n  \"body\": \"This method will return a specific board on your account by id and also its widgets details.\"\n}\n[/block]\n\n## Create a Board\n[block:callout]\n{\n  \"type\": \"success\",\n  \"title\": \"POST https://api.telemetrytv.com/boards\",\n  \"body\": \"This method will create a new board.\"\n}\n[/block]\n## Import a Board\n[block:callout]\n{\n  \"type\": \"success\",\n  \"title\": \"POST https://api.telemetrytv.com/boards/import\",\n  \"body\": \"This method will create a new board and widgets based on the json input.\"\n}\n[/block]\n## Update a Board\n[block:callout]\n{\n  \"type\": \"warning\",\n  \"title\": \"PATCH https://api.telemetrytv.com/boards/:id\",\n  \"body\": \"This method will update a board object.\"\n}\n[/block]\n## Delete a Board\n[block:callout]\n{\n  \"type\": \"danger\",\n  \"title\": \"DELETE https://api.telemetrytv.com/boards/:id\",\n  \"body\": \"This method will delete a board object.\"\n}\n[/block]","excerpt":"","slug":"boards","type":"basic","title":"Boards"}
The boards object represent the boards (dashboards) within your account. Boards are collections of widgets and their flows contained together for display. ## Board Object [block:parameters] { "data": { "h-0": "Parameter", "h-1": "Description", "0-0": "id", "1-0": "name", "2-0": "theme", "3-0": "columns", "4-0": "rows", "5-0": "size", "6-0": "aspect_ratio", "7-0": "display_board_name", "8-0": "widget_margins", "9-0": "widget_padding", "10-0": "font_size", "11-0": "font_family", "0-1": "A globally unique static string identifying the object.", "1-1": "The name of the board.", "2-1": "The theme for the board.", "3-1": "The number of columns in the board grid.", "4-1": "The number of rows in the board grid.", "5-1": "An array representing the native size of the board.", "6-1": "A string with the aspect ratio of the board.", "7-1": "Whether to show the board name at the top of the board or not.", "8-1": "The external margin of a widget, defaults to 3.", "9-1": "The internal padding of a widget, defaults to 8.", "10-1": "The size of the font to use, can be 'small', 'normal' or 'large'.", "11-1": "The font family to use, defaults to 'normal' which uses the theme default.", "12-0": "background_color", "12-1": "The background color of the board.", "13-0": "background_url", "13-1": "The background image URL of the board.", "14-0": "widget_color", "14-1": "The background color of the widgets.", "15-0": "widget_title_color", "15-1": "The color of the widgets' titles.", "16-0": "widget_title_size", "16-1": "The size of the widgets' titles." }, "cols": 2, "rows": 17 } [/block] ## Boards Listing [block:callout] { "type": "info", "title": "GET https://api.telemetrytv.com/boards", "body": "This method will return a list of all boards on your account." } [/block] ## Board Details [block:callout] { "type": "info", "title": "GET https://api.telemetrytv.com/boards/:id", "body": "This method will return a specific board on your account by id." } [/block] ## Export Board [block:callout] { "type": "info", "title": "GET https://api.telemetrytv.com/boards/:id/export", "body": "This method will return a specific board on your account by id and also its widgets details." } [/block] ## Create a Board [block:callout] { "type": "success", "title": "POST https://api.telemetrytv.com/boards", "body": "This method will create a new board." } [/block] ## Import a Board [block:callout] { "type": "success", "title": "POST https://api.telemetrytv.com/boards/import", "body": "This method will create a new board and widgets based on the json input." } [/block] ## Update a Board [block:callout] { "type": "warning", "title": "PATCH https://api.telemetrytv.com/boards/:id", "body": "This method will update a board object." } [/block] ## Delete a Board [block:callout] { "type": "danger", "title": "DELETE https://api.telemetrytv.com/boards/:id", "body": "This method will delete a board object." } [/block]