{"_id":"57ab77de54fa780e006c53ff","parentDoc":null,"user":"54c7fdeae317000d007c2765","version":{"_id":"563a252d50bf950d00e0979b","__v":7,"project":"563a252d50bf950d00e09798","createdAt":"2015-11-04T15:33:01.701Z","releaseDate":"2015-11-04T15:33:01.701Z","categories":["563a252e50bf950d00e0979c","563a2a691846790d008952fe","563a3394daf1c00d00136d9b","563a3467d25e8919005f3f0c","563a347850bf950d00e097b4","570e5cec10aa423200391fb5","5890d358d6cb8e2500a3f311"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"__v":1,"category":{"_id":"563a252e50bf950d00e0979c","project":"563a252d50bf950d00e09798","pages":["563a252f50bf950d00e0979e","563a35ac1846790d0089532c","563d1407d8f2d20d00448d3c","563d1d3f9799fb0d0004776a","564509aa2c74cf1900da48c7","56453b7e9f3f550d00fa3c7b","564b498aeed7de0d003672c3","564b523ce5d9d61700d580e0","564b58ea1a8e610d006bfd49","564b59baee12850d00958656","564b6773d969330d00aba984","564b69b2d7b95d0d00ed050f","564b7fa8cc472d0d00da9447","564b905fa8a0ba21002ad6b1","564ba051288b1a2b00b3ae83","564ba6275cc43717009bcff1","564bb2138841060d00abb2e0","564bb74e05c99e1700161dd1","564c8ad60ddedc210051e582","564cca42d0c5b42b002305e8","564cca8ecfa4452b0019926d","564ce34f404ce53500fdb255","564cea76404ce53500fdb272","564cedb77d4d31170028dd2e","564cefc1bc81632100b10468","564cf17d1f42792b00820515","564cf5462248461700bd4017","564ddd49a8671617004e7b90","564ddf9ead1d5217003e2e18","564de1dea8671617004e7b99","564de3c11133043500f4bf96","564de669e39c4435005a1f65","564df3f16eaa3a2100868961","5655d3519347d30d00d7e8e2"],"version":"563a252d50bf950d00e0979b","__v":34,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-11-04T15:33:02.244Z","from_sync":false,"order":9999,"slug":"documentation","title":"Documentation"},"project":"563a252d50bf950d00e09798","updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-08-10T18:52:14.005Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"settings":"","results":{"codes":[]},"auth":"required","params":[],"url":""},"isReference":false,"order":19,"body":"[block:api-header]\n{\n  \"type\": \"get\",\n  \"title\": \"GET /groups/{id}/default-tabs\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"Description\",\n    \"0-1\": \"Retrieve a list of default tabs (now called dashboards) for a specific group.\",\n    \"1-0\": \"Permissions\",\n    \"2-0\": \"Resource URL\",\n    \"3-0\": \"Parameters\",\n    \"1-1\": \"user.manage\",\n    \"2-1\": \"https://app.klipfolio.com/api/1.0/groups/{id}/default-tabs\",\n    \"3-1\": \"tab_id (string) — show only dashboards that belong to a specific group\\ntab_name (string) — show dashboard name \\ndescription — information about the dashboard\\ncan_edit — true/false\\nvisibility — library, dashboard,permanent\\nindex — tab position\\nid — default tab ID\"\n  },\n  \"cols\": 2,\n  \"rows\": 4\n}\n[/block]\n##Example Request\n`GET https://app.klipfolio.com/api/1.0/groups/bdd7b4d0a729704164ab4b38e788de21/default-tabs`\n\n##Example Response\n```\n{\n  \"meta\": {\n    \"success\": true,\n    \"status\": 200\n  },\n  \"data\": {\n    \"tabs\": [\n      {\n        \"tab_id\": \"fc67d8f1646b3333e1641e1085a5e555\",\n        \"tab_name\": \"Group Sales\",\n        \"description\": null,\n        \"can_edit\": false,\n        \"visibility\": \"permanent\",\n        \"index\": 1,\n        \"id\": \"caadadb4b08f36973c4446e459b14deb\"\n      }\n    ]\n  }\n}\n``` \n\n[block:api-header]\n{\n  \"type\": \"get\",\n  \"title\": \"GET /groups/{id}/default-tabs/{id}\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"0-1\": \"Retrieve the details for a specific group default tab.\",\n    \"0-0\": \"Description\",\n    \"1-0\": \"Permissions\",\n    \"2-0\": \"Resource URL\",\n    \"3-0\": \"Parameters\",\n    \"1-1\": \"user.manage\",\n    \"2-1\": \"https://app.klipfolio.com/api/1.0/groups/{id}/default-tabs/{id}\",\n    \"3-1\": \"tab_id (string) — show only dashboards that belong to a specific group\\ntab_name (string) — show dashboard name \\ndescription — information about the dashboard\\ncan_edit — true/false\\nvisibility — library, dashboard,permanent\\nindex — tab position\\nid — default tab ID\\nklips_shared\\ntotal_klips\"\n  },\n  \"cols\": 2,\n  \"rows\": 4\n}\n[/block]\n##Example Request\n`https://app.klipfolio.com/api/1.0/groups/dbb7b4d0a729704164ab4b38e799de11/default-tabs/caadadb4b08f36973c4446e459b14deb`\n##Example Response\n```\n{\n  \"meta\": {\n    \"success\": true,\n    \"status\": 200\n  },\n  \"data\": {\n    \"id\": \"caadadb4b08f36973c4446e459b14deb\",\n    \"tab_id\": \"fc67d8f1646b2306e1641e1085a5e704\",\n    \"tab_name\": \"Group Sales\",\n    \"description\": null,\n    \"can_edit\": false,\n    \"visibility\": \"permanent\",\n    \"index\": 1,\n    \"klips_shared\": 1,\n    \"total_klips\": 2\n  }\n}\n\n``` \n\n[block:api-header]\n{\n  \"type\": \"post\",\n  \"title\": \"POST /groups/{id}/default-tabs\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"Description\",\n    \"0-1\": \"Add a new default dashboard to a specified group.\",\n    \"1-0\": \"Permissions\",\n    \"2-0\": \"Resource URL\",\n    \"3-0\": \"Parameters\",\n    \"1-1\": \"user.manage\",\n    \"2-1\": \"https://app.klipfolio.com/api/1.0/groups/{id}/default-tabs\",\n    \"3-1\": \"None.\"\n  },\n  \"cols\": 2,\n  \"rows\": 4\n}\n[/block]\n##Example Request\n`https://app.klipfolio.com/api/1.0/groups/dbb7b4d0a729704164ab4b38e799de11/default-tabs -d \"{'tab_id':'fc67d8f1646b2306e1641e1085a5e704','can_edit':true,'visibility':'dashboard','index':1}\"`\n\n##Example Response\n```\n{\n  \"meta\": {\n    \"success\": true,\n    \"status\": 201,\n    \"location\": \"/groups/dbb7b4d0a729704164ab4b38e799de11/default-tabs/caadadb4b08f36973c4446e459b14deb\"\n  },\n  \"data\": {}\n}\n```\n[block:api-header]\n{\n  \"type\": \"put\",\n  \"title\": \"PUT /groups/{id}/default-tabs/{id}\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"Description\",\n    \"0-1\": \"Update an existing default dashboard for a  specified group.\",\n    \"1-0\": \"Permissions\",\n    \"2-0\": \"Resource URL\",\n    \"3-0\": \"Parameters\",\n    \"1-1\": \"dashboard.library\",\n    \"2-1\": \"https://app.klipfolio.com/api/1.0/groups/{id}\",\n    \"3-1\": \"name, description, external_id\"\n  },\n  \"cols\": 2,\n  \"rows\": 4\n}\n[/block]\n##Example Request\n`PUT https://app.klipfolio.com/api/1.0/groups/dbb7b4d0a729704164ab4b38e799de11/default-tabs/caadadb4b08f36973c4446e459b14deb -d \"{'tab_id':'fc67d8f1646b2306e1641e1085a5e704',description:'Finance dashboard'}\"`\n\n##Example Response\n```\n{\n  \"meta\": {\n    \"success\": true,\n    \"status\": 200\n  },\n  \"data\": {}\n}\n```\n[block:api-header]\n{\n  \"type\": \"delete\",\n  \"title\": \"DELETE /groups/{id}/default-tabs/{id}\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"Description\",\n    \"0-1\": \"Delete the specified group default dashboard.\",\n    \"1-0\": \"Permissions\",\n    \"2-0\": \"Resource URL\",\n    \"3-0\": \"Parameters\",\n    \"1-1\": \"user.manage\",\n    \"2-1\": \"https://app.klipfolio.com/api/1.0/groups/{id}/default-tabs/{id}\",\n    \"3-1\": \"None.\"\n  },\n  \"cols\": 2,\n  \"rows\": 4\n}\n[/block]\n##Example Request\n`DELETE https://app.klipfolio.com/api/1.0/groups/dbb7b4d0a729704164ab4b38e799de11/default-tabs/caadadb4b08f36973c4446e459b14deb`\n##Example Response\n```\n{\n\"meta\": {\n      \"status\": 200,\n      \"success\": true\n  }\n}\n```","excerpt":"","slug":"groups-default-tabs","type":"basic","title":"Groups Default Tabs"}

Groups Default Tabs


[block:api-header] { "type": "get", "title": "GET /groups/{id}/default-tabs" } [/block] [block:parameters] { "data": { "0-0": "Description", "0-1": "Retrieve a list of default tabs (now called dashboards) for a specific group.", "1-0": "Permissions", "2-0": "Resource URL", "3-0": "Parameters", "1-1": "user.manage", "2-1": "https://app.klipfolio.com/api/1.0/groups/{id}/default-tabs", "3-1": "tab_id (string) — show only dashboards that belong to a specific group\ntab_name (string) — show dashboard name \ndescription — information about the dashboard\ncan_edit — true/false\nvisibility — library, dashboard,permanent\nindex — tab position\nid — default tab ID" }, "cols": 2, "rows": 4 } [/block] ##Example Request `GET https://app.klipfolio.com/api/1.0/groups/bdd7b4d0a729704164ab4b38e788de21/default-tabs` ##Example Response ``` { "meta": { "success": true, "status": 200 }, "data": { "tabs": [ { "tab_id": "fc67d8f1646b3333e1641e1085a5e555", "tab_name": "Group Sales", "description": null, "can_edit": false, "visibility": "permanent", "index": 1, "id": "caadadb4b08f36973c4446e459b14deb" } ] } } ```  [block:api-header] { "type": "get", "title": "GET /groups/{id}/default-tabs/{id}" } [/block] [block:parameters] { "data": { "0-1": "Retrieve the details for a specific group default tab.", "0-0": "Description", "1-0": "Permissions", "2-0": "Resource URL", "3-0": "Parameters", "1-1": "user.manage", "2-1": "https://app.klipfolio.com/api/1.0/groups/{id}/default-tabs/{id}", "3-1": "tab_id (string) — show only dashboards that belong to a specific group\ntab_name (string) — show dashboard name \ndescription — information about the dashboard\ncan_edit — true/false\nvisibility — library, dashboard,permanent\nindex — tab position\nid — default tab ID\nklips_shared\ntotal_klips" }, "cols": 2, "rows": 4 } [/block] ##Example Request `https://app.klipfolio.com/api/1.0/groups/dbb7b4d0a729704164ab4b38e799de11/default-tabs/caadadb4b08f36973c4446e459b14deb` ##Example Response ``` { "meta": { "success": true, "status": 200 }, "data": { "id": "caadadb4b08f36973c4446e459b14deb", "tab_id": "fc67d8f1646b2306e1641e1085a5e704", "tab_name": "Group Sales", "description": null, "can_edit": false, "visibility": "permanent", "index": 1, "klips_shared": 1, "total_klips": 2 } } ```  [block:api-header] { "type": "post", "title": "POST /groups/{id}/default-tabs" } [/block] [block:parameters] { "data": { "0-0": "Description", "0-1": "Add a new default dashboard to a specified group.", "1-0": "Permissions", "2-0": "Resource URL", "3-0": "Parameters", "1-1": "user.manage", "2-1": "https://app.klipfolio.com/api/1.0/groups/{id}/default-tabs", "3-1": "None." }, "cols": 2, "rows": 4 } [/block] ##Example Request `https://app.klipfolio.com/api/1.0/groups/dbb7b4d0a729704164ab4b38e799de11/default-tabs -d "{'tab_id':'fc67d8f1646b2306e1641e1085a5e704','can_edit':true,'visibility':'dashboard','index':1}"` ##Example Response ``` { "meta": { "success": true, "status": 201, "location": "/groups/dbb7b4d0a729704164ab4b38e799de11/default-tabs/caadadb4b08f36973c4446e459b14deb" }, "data": {} } ``` [block:api-header] { "type": "put", "title": "PUT /groups/{id}/default-tabs/{id}" } [/block] [block:parameters] { "data": { "0-0": "Description", "0-1": "Update an existing default dashboard for a specified group.", "1-0": "Permissions", "2-0": "Resource URL", "3-0": "Parameters", "1-1": "dashboard.library", "2-1": "https://app.klipfolio.com/api/1.0/groups/{id}", "3-1": "name, description, external_id" }, "cols": 2, "rows": 4 } [/block] ##Example Request `PUT https://app.klipfolio.com/api/1.0/groups/dbb7b4d0a729704164ab4b38e799de11/default-tabs/caadadb4b08f36973c4446e459b14deb -d "{'tab_id':'fc67d8f1646b2306e1641e1085a5e704',description:'Finance dashboard'}"` ##Example Response ``` { "meta": { "success": true, "status": 200 }, "data": {} } ``` [block:api-header] { "type": "delete", "title": "DELETE /groups/{id}/default-tabs/{id}" } [/block] [block:parameters] { "data": { "0-0": "Description", "0-1": "Delete the specified group default dashboard.", "1-0": "Permissions", "2-0": "Resource URL", "3-0": "Parameters", "1-1": "user.manage", "2-1": "https://app.klipfolio.com/api/1.0/groups/{id}/default-tabs/{id}", "3-1": "None." }, "cols": 2, "rows": 4 } [/block] ##Example Request `DELETE https://app.klipfolio.com/api/1.0/groups/dbb7b4d0a729704164ab4b38e799de11/default-tabs/caadadb4b08f36973c4446e459b14deb` ##Example Response ``` { "meta": { "status": 200, "success": true } } ```