The DAKboard API is organized around REST. Our API has predictable resource-oriented URLs, accepts form-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.
\nRequests
\nResponse
\nAuthentication
\nThe DAKboard API uses API keys to authenticate requests. You can view and manage your API keys in your DAKboard account.
\nYour API keys carry many privileges, so be sure to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, client-side code, and so forth.
\nAll requests must include an API key in the URL as a parameter in the following format:\napi_key=yourAPIkey.
Updates and Versioning
\nThe DAKboard API is updated frequently as new functionality is added. When we make backwards-incompatible changes to the API, we release a new, numbered version. The current version is 2.
\nIf there's a feature or functionality you'd like to see, please contact our support team at contact@dakboard.com to submit a feature request.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"8098574","collectionId":"42831d0b-a40a-4898-b216-a8d23a16806f","publishedId":"SVSGNAGs","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2019-07-11T02:36:07.000Z"},"item":[{"name":"Screens","item":[{"name":"List all screens","id":"dc4a0464-ba18-487a-bbe5-4d6e3d8042fc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"api_key"},{"key":"value","value":"Returns a list of your screens. The screens are returned sorted by creation date, with the most recently created screens appearing first.
\n","urlObject":{"protocol":"https","path":["api","2","screens"],"host":["dakboard","com"],"query":[],"variable":[]}},"response":[{"id":"a372b0d8-6cc4-4e65-925c-c57b55df9f36","name":"Screen List","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://dakboard.com/api/2/screens?api_key=a1b2c3d4e5f6","protocol":"https","host":["dakboard","com"],"path":["api","2","screens"],"query":[{"key":"api_key","value":"a1b2c3d4e5f6","description":"Required."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 11 Jul 2019 02:34:20 GMT"},{"key":"Server","value":"Apache/2.4.18 (Ubuntu)"},{"key":"Content-Length","value":"3000"},{"key":"Connection","value":"close"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": \"scr_8cf90764d747\",\n \"name\": \"Conference Room 3\",\n \"width\": \"1920\",\n \"height\": \"1080\",\n \"orientation\": \"landscape\",\n \"version\": \"2177\",\n \"is_default\": \"1\"\n }\n]"}],"_postman_id":"dc4a0464-ba18-487a-bbe5-4d6e3d8042fc"},{"name":"Retrieve a screen","id":"f11c9c9c-79cf-41c4-ac6b-265d18e12c33","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://dakboard.com/api/2/screens/:screenId","description":"Retrieves the details of an existing screen. Supply the unique screen ID from either a screen creation request or the screen list, and DAKboard will return the corresponding screen information.
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"api_key"},{"key":"value","value":"Create a screen directly in your DAKboard account. Screen creation is not yet supported by the API.
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"api_key"},{"key":"value","value":"Updates the specific screen by setting the values of the parameters passed. Any parameters not provided will be left unchanged. Only the body parameters listed below are allowed to be changed.
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"api_key"},{"key":"value","value":"Returns a list of all blocks for the provided screen ID.
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"api_key"},{"key":"value","value":"Retrieves the details of an existing block that's part of an existing screen. Supply the unique screen ID and block ID from either a block creation request or the block list, and DAKboard will return the corresponding block information.
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"api_key"},{"key":"value","value":"Updates the specific block by setting the values of the parameters passed. Any parameters not provided will be left unchanged. Only the body parameters listed below are allowed to be changed.
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"api_key"},{"key":"value","value":"A screen is the software configuration of your content and can be found in the Screens section of your DAKboard account. Each screen can have 0 or more blocks. A block is a specific piece of conent, ie., a calendar, photos, weather, datetime block, etc. The screens API provides a collection of endpoints for retrieving and updating DAKboard screens and blocks.
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"api_key"},{"key":"value","value":"Returns a list of your loops. The loops are returned sorted by creation date, with the most recently created loops appearing first.
\n","urlObject":{"protocol":"https","path":["api","2","loops"],"host":["dakboard","com"],"query":[],"variable":[]}},"response":[{"id":"38140c14-a1f1-450a-868c-ede0486e52dc","name":"List all loops","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://dakboard.com/api/2/loops?api_key=a1b2c3d4e5f6","protocol":"https","host":["dakboard","com"],"path":["api","2","loops"],"query":[{"key":"api_key","value":"a1b2c3d4e5f6"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": \"lop_dce4ca74c343\",\n \"name\": \"Conference Room 1\",\n \"rotate_freq\": \"300\",\n \"transition_speed\": \"0\",\n \"version\": \"12\",\n \"screens\": [\n \"scr_4946631ee073\",\n \"scr_8cf90764d747\"\n ]\n },\n {\n \"id\": \"lop_7be22338a74c\",\n \"name\": \"Entrance Loop\",\n \"rotate_freq\": \"15\",\n \"transition_speed\": \"0.25\",\n \"version\": \"5\",\n \"screens\": [\n \"scr_8049365ec9ca\",\n \"scr_4946631ee073\",\n \"scr_df46943ba679\"\n ]\n }\n]"}],"_postman_id":"ef6e1686-19aa-4c5d-8e3f-7db3385b54d6"},{"name":"Retrieve a loop","id":"55da2e71-6205-43a3-9de2-8caa20722f28","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://dakboard.com/api/2/loops/:loopId","description":"Retrieves the details of a display or device. Supply the unique device ID from either a device creation request or the device list, and DAKboard will return the corresponding device information.
\n","urlObject":{"protocol":"https","path":["api","2","loops",":loopId"],"host":["dakboard","com"],"query":[],"variable":[{"type":"string","value":"The unique ID of the loop","key":"loopId"}]}},"response":[{"id":"681cf5ac-9100-4940-888d-f5cd5bf8996f","name":"Retrieve a loop","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://dakboard.com/api/2/loops/lop_dce4ca74c343?api_key=a1b2c3d4e5f6","protocol":"https","host":["dakboard","com"],"path":["api","2","loops","lop_dce4ca74c343"],"query":[{"key":"api_key","value":"a1b2c3d4e5f6"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"id\": \"lop_dce4ca74c343\",\n \"name\": \"Conference Room 1\",\n \"rotate_freq\": \"300\",\n \"transition_speed\": \"0\",\n \"version\": \"12\",\n \"screens\": [\n \"scr_4946631ee073\",\n \"scr_8cf90764d747\"\n ]\n}"}],"_postman_id":"55da2e71-6205-43a3-9de2-8caa20722f28"},{"name":"Update a loop","id":"a9d125a6-aa9a-488b-93da-a065a4fd289c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"urlencoded","urlencoded":[]},"url":"","description":"Loop updates can be made directly in your DAKboard account. Updates are not yet supported by the API.
\n","urlObject":{"query":[],"variable":[]}},"response":[],"_postman_id":"a9d125a6-aa9a-488b-93da-a065a4fd289c"}],"id":"83ae4744-1f3e-4b58-a30b-e173789a6a04","description":"A loop contains 1 or more DAKboard screens that can be combined into a single screen, and shown on a rotating basis (looped). The Loops API provides a collection of enpoints for retrieving and updating loops your DAKboard account.
\n","event":[{"listen":"prerequest","script":{"id":"cc8008dd-a248-4be1-93c7-28fbc66e838d","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"c70df66e-1a41-4f79-a4a9-0e8ad52a8a3e","type":"text/javascript","exec":[""]}}],"_postman_id":"83ae4744-1f3e-4b58-a30b-e173789a6a04"},{"name":"Devices","item":[{"name":"List all devices","id":"c260e072-3ab9-41de-9732-e1b274237d21","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://dakboard.com/api/2/devices","description":"Returns a list of your displays and devices. The devices are returned sorted by creation date, with the most recently created devices appearing first.
\n","urlObject":{"protocol":"https","path":["api","2","devices"],"host":["dakboard","com"],"query":[],"variable":[]}},"response":[{"id":"3be3c07f-23bd-4be4-9d8b-3b6254c815f6","name":"List all devices","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://dakboard.com/api/2/devices?api_key=a1b2c3d4e5f6","protocol":"https","host":["dakboard","com"],"path":["api","2","devices"],"query":[{"key":"api_key","value":"a1b2c3d4e5f6"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"[\n {\n \"id\":\"dev_7mzab2mdbwsq\",\n \"name\": \"Office Display\",\n \"serial_num\": \"ABC123\",\n \"model\": \"AOC I2476VWM (Ansen)\",\n \"ip_addr\": \"192.168.1.118\",\n \"last_connect\": \"1554744197\",\n \"screen_id\": \"scr_8049365ec9ca\",\n \"screen_type\": \"screen\"\n },\n {\n \t\"id\":\"dev_al39vb3cb308\",\n \"name\": \"Front Room Display\",\n \"serial_num\": \"XYZ789\",\n \"model\": \"L238DPH-2NS [1.81]\",\n \"ip_addr\": \"192.168.1.27\",\n \"last_connect\": \"1561059573\",\n \"screen_id\": \"loo_7be22338a74c\",\n \"screen_type\": \"loop\"\n }\n]"}],"_postman_id":"c260e072-3ab9-41de-9732-e1b274237d21"},{"name":"Retrieve a device","id":"a5c4c321-babc-4c0c-a5c1-2e10d13eedf1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://dakboard.com/api/2/devices/:deviceId","description":"Retrieves the details of a display or device. Supply the unique device ID from either a device creation request or the device list, and DAKboard will return the corresponding device information.
\n","urlObject":{"protocol":"https","path":["api","2","devices",":deviceId"],"host":["dakboard","com"],"query":[],"variable":[{"type":"string","value":"The unique ID of the device","key":"deviceId"}]}},"response":[{"id":"c53e021c-82b3-4383-96d2-461e11b02bef","name":"Retrieve a device","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://dakboard.com/api/2/devices/dev_7mzab2mdbwsq?api_key=a1b2c3d4e5f6","protocol":"https","host":["dakboard","com"],"path":["api","2","devices","dev_7mzab2mdbwsq"],"query":[{"key":"api_key","value":"a1b2c3d4e5f6"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"id\":\"dev_7mzab2mdbwsq\",\n \"name\": \"Office Display\",\n \"serial_num\": \"ABC123\",\n \"model\": \"AOC I2476VWM (Ansen)\",\n \"ip_addr\": \"192.168.1.118\",\n \"last_connect\": \"1554744197\",\n \"screen_id\": \"scr_8049365ec9ca\",\n \"screen_type\": \"screen\"\n}"}],"_postman_id":"a5c4c321-babc-4c0c-a5c1-2e10d13eedf1"},{"name":"Update a device","id":"288c7cae-074a-4e89-98b3-9c2b1cb660c0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"name","value":"String. The name of the device","type":"text"},{"key":"ip_addr","value":"String. The IP address of the device","type":"text"},{"key":"screen_id","value":"String. The unique ID of the screen or loop to show on this device.","type":"text"}]},"url":"https://dakboard.com/api/2/devices/:deviceId","description":"Updates the specific device by setting the values of the body parameters passed. Any parameters not provided will be left unchanged. Only the body parameters listed below are allowed to be changed.
\n","urlObject":{"protocol":"https","path":["api","2","devices",":deviceId"],"host":["dakboard","com"],"query":[],"variable":[{"type":"string","value":"The unique ID of the device","key":"deviceId"}]}},"response":[{"id":"d3b2ad8f-4688-41b4-99cf-181bbd48b292","name":"Update a device","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"name=My New Name"},"url":{"raw":"https://dakboard.com/api/2/devices/dev_7mzab2mdbwsq?api_key=a1b2c3d4e5f6","protocol":"https","host":["dakboard","com"],"path":["api","2","devices","dev_7mzab2mdbwsq"],"query":[{"key":"api_key","value":"a1b2c3d4e5f6"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"id\":\"dev_7mzab2mdbwsq\",\n \"name\": \"My New Name\",\n \"serial_num\": \"ABC123\",\n \"model\": \"AOC I2476VWM (Ansen)\",\n \"ip_addr\": \"192.168.1.118\",\n \"last_connect\": \"1554744197\",\n \"screen_id\": \"scr_8049365ec9ca\",\n \"screen_type\": \"screen\"\n}"}],"_postman_id":"288c7cae-074a-4e89-98b3-9c2b1cb660c0"}],"id":"591e14a8-9fdc-4752-b622-70c810d51f39","description":"A device is a physical device such as a DAKboard Wall Display, CPU, Raspberry Pi etc., that is used to display a DAKboard screen. The Devices API provides a collection of enpoints for retrieving and updating devices and displays in your DAKboard account.
\n","event":[{"listen":"prerequest","script":{"id":"cc8008dd-a248-4be1-93c7-28fbc66e838d","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"c70df66e-1a41-4f79-a4a9-0e8ad52a8a3e","type":"text/javascript","exec":[""]}}],"_postman_id":"591e14a8-9fdc-4752-b622-70c810d51f39"},{"name":"Metrics","item":[{"name":"List all metrics","id":"2070373f-75fb-4d50-9c03-1100245b4078","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"api_key"},{"key":"value","value":"New or Existing metric_name (Valid characters: alphanumeric, dash, or underscore)
\n","type":"text/plain"},"type":"any","value":"","key":"metric_name"}]}},"response":[{"id":"0473c430-6f4e-4ec5-b20e-49e27c6029a8","name":"SUCCESSFUL","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"[\r\n {\r\n \"timestamp\": \"2023-01-01 00:00:00\",\r\n \"value\": 123.456,\r\n \"expires\": \"2023-02-01 00:00:00\"\r\n },\r\n {\r\n \"timestamp\": 1672531260,\r\n \"value\":234.567,\r\n \"expires\":1675209600\r\n },\r\n {\r\n \"value\":345\r\n }\r\n]","options":{"raw":{"language":"json"}}},"url":{"raw":"https://dakboard.com/api/2/metrics/My_Metrics_Data?api_key=a1b2c3d4e5f6","protocol":"https","host":["dakboard","com"],"path":["api","2","metrics","My_Metrics_Data"],"query":[{"key":"api_key","value":"a1b2c3d4e5f6"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":""},{"id":"1746c643-d7b1-41e6-8bc5-2bab3beb7424","name":"FAILURE - General Error","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"[\r\n {\r\n timestamp: \"2023-01-01 00:00:00\",\r\n value: 123.456,\r\n expires: \"2023-02-01 00:00:00\"\r\n },\r\n {\r\n timestamp: 1672531260,\r\n value:234.567,\r\n expires:1675209600\r\n }\r\n]","options":{"raw":{"language":"json"}}},"url":{"raw":"https://dakboard.com/api/2/metrics/My_Metrics_Data?api_key=a1b2c3d4e5f6","protocol":"https","host":["dakboard","com"],"path":["api","2","metrics","My_Metrics_Data"],"query":[{"key":"api_key","value":"a1b2c3d4e5f6"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\r\n \"code\": 400,\r\n \"status\": \"error\",\r\n \"message\": \"A description of the problem\"\r\n}"}],"_postman_id":"76338031-20e4-44b1-bf79-076e25c2795c"},{"name":"Remove a metric","id":"8f98b5c9-3dc1-40e4-89a0-657b053c4f30","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://dakboard.com/api/2/metrics/:metric_name","urlObject":{"protocol":"https","path":["api","2","metrics",":metric_name"],"host":["dakboard","com"],"query":[],"variable":[{"id":"1a829c07-d330-4602-b552-58aa1404a5f7","description":{"content":"Existing metric_name
\n","type":"text/plain"},"type":"any","value":"","key":"metric_name"}]}},"response":[{"id":"084d7aed-2d62-4504-9859-f1a13feb616a","name":"SUCCESSFUL","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":{"raw":"https://dakboard.com/api/2/metrics/My_Metrics_Data?api_key=a1b2c3d4e5f6","protocol":"https","host":["dakboard","com"],"path":["api","2","metrics","My_Metrics_Data"],"query":[{"key":"api_key","value":"a1b2c3d4e5f6"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":""},{"id":"fff1711c-89b4-4fea-a563-4f4f5f34a224","name":"FAILURE - General Error","originalRequest":{"method":"DELETE","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":{"raw":"https://dakboard.com/api/2/metrics/My_Metrics_Data?api_key=a1b2c3d4e5f6","protocol":"https","host":["dakboard","com"],"path":["api","2","metrics","My_Metrics_Data"],"query":[{"key":"api_key","value":"a1b2c3d4e5f6"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\r\n \"code\": 400,\r\n \"status\": \"error\",\r\n \"messag\": \"A description of the problem\"\r\n}"}],"_postman_id":"8f98b5c9-3dc1-40e4-89a0-657b053c4f30"},{"name":"Remove metric data point(s)","id":"9d1f7ae0-6ac5-44bc-986b-c8c5888e02f6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"body":{"mode":"raw","raw":"{\r\n \"timestamp\": 1672531260\r\n}","options":{"raw":{"language":"json"}}},"url":"https://dakboard.com/api/2/metrics/:metric_name","urlObject":{"protocol":"https","path":["api","2","metrics",":metric_name"],"host":["dakboard","com"],"query":[],"variable":[{"id":"86301daf-7dc9-4a23-82f4-14a25c7b1ecd","description":{"content":"Existing metric_name
\n","type":"text/plain"},"type":"any","value":"","key":"metric_name"}]}},"response":[{"id":"c598886c-ad9d-4c77-9139-6d61253053b4","name":"SUCCESSFUL","originalRequest":{"method":"DELETE","header":[],"body":{"mode":"raw","raw":"{\r\n \"timestamp\": 1672531260\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://dakboard.com/api/2/metrics/My_Metrics_Data?api_key=a1b2c3d4e5f6","protocol":"https","host":["dakboard","com"],"path":["api","2","metrics","My_Metrics_Data"],"query":[{"key":"api_key","value":"a1b2c3d4e5f6"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":""},{"id":"50a33005-46e9-493e-9cd0-c0e4a88db7fc","name":"FAILURE - General Error","originalRequest":{"method":"DELETE","header":[],"body":{"mode":"raw","raw":"{\r\n \"timestamp\": 1672531260\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://dakboard.com/api/2/metrics/My_Metrics_Data?api_key=a1b2c3d4e5f6","protocol":"https","host":["dakboard","com"],"path":["api","2","metrics","My_Metrics_Data"],"query":[{"key":"api_key","value":"a1b2c3d4e5f6"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\r\n \"code\": 400,\r\n \"status\": \"error\",\r\n \"message\": \"A description of the problem\"\r\n}"}],"_postman_id":"9d1f7ae0-6ac5-44bc-986b-c8c5888e02f6"}],"id":"35f4bed1-de95-4e55-85de-6d6713319e89","_postman_id":"35f4bed1-de95-4e55-85de-6d6713319e89","description":""}],"event":[{"listen":"prerequest","script":{"id":"a6f5f3ee-80c4-4d85-a5e2-14a1ef9b3807","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"4ca884c9-a623-43fb-a70a-6135cf7faa6b","type":"text/javascript","exec":[""]}}]}