{"_id":"564cea76404ce53500fdb272","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"},"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":4,"project":"563a252d50bf950d00e09798","updates":["57dfaca55ca3730e0074c946"],"next":{"pages":[],"description":""},"createdAt":"2015-11-18T21:15:34.927Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":31,"body":"[block:api-header]\n{\n  \"type\": \"get\",\n  \"title\": \"GET /tabs/{id}/klip-instances\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"Description\",\n    \"0-1\": \"Get a list of the Klip instances associated with the tab.\",\n    \"1-0\": \"Permissions\",\n    \"2-0\": \"Resource URL\",\n    \"3-0\": \"Parameters\",\n    \"1-1\": \"dashboard.tab\",\n    \"2-1\": \"https://app.klipfolio.com/api/1.0/tabs/{id}/klip-instances\",\n    \"3-1\": \"tab id={id}\"\n  },\n  \"cols\": 2,\n  \"rows\": 4\n}\n[/block]\n##Example Request\n`GET https://app.klipfolio.com/api/1/tabs/fedcba9876543210fedcba9876543210/klip-instances`\n\n##Example Response\n```\n{\n \"data\": {\n  \"klip_instances\":\n [{\n   \"id\":\"04462abd3a38372173645f3b50128596\",   \n   \"klip_id\":\"b2f4179cdc4f5a022a80310fe93b1022\",\n   \"name\":\"Visits and Goals\"\n }]\n  },\n \"meta\": {\n     \"status\": 200,\n     \"success\": true\n }\n}\n```\n[block:api-header]\n{\n  \"type\": \"put\",\n  \"title\": \"PUT /tabs/{id}/klip-instances\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"0-1\": \"Add a Klip to a tab. The Klip id is used instead of the Klip instance id. \\n*Note:* If region and position are not included, they default to 1 and 0 respectively.\",\n    \"0-0\": \"Description\",\n    \"1-0\": \"Permissions\",\n    \"2-0\": \"Resource URL\",\n    \"3-0\": \"Fields\",\n    \"1-1\": \"dashboard.tab\",\n    \"2-1\": \"https://app.klipfolio.com/api/1.0/tabs/{id}/klip-instances\",\n    \"3-1\": \"Klips\"\n  },\n  \"cols\": 2,\n  \"rows\": 4\n}\n[/block]\n##Example Request\n`PUT https://app.klipfolio.com/api/1.0/tabs/ca74a78906543be66b2z9c123e76b1bc/klip-instances -d \n{'klips': [{'klip_id': 'd012d123b56123d1234ef12c8f12c123', 'region': 0, 'position': 1}]}`\n\n##Example Response\n```\n{\n  \"meta\": {\n    \"success\": true,\n    \"status\": 200\n  },\n  \"data\": {\n    \"klip_instances\": [\n      {\n        \"id\": \"12a123c123ef12333cbf7d3d864f674\",\n        \"klip_id\": \"d012d123b56123d1234ef12c8f12c123\",\n        \"name\": \"Klipfolio API, Client Dynamic, filter Active\"\n      }\n    ]\n  }\n}\n```\n[block:api-header]\n{\n  \"type\": \"delete\",\n  \"title\": \"DELETE /tabs/{id}/klip-instances/\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"Description\",\n    \"0-1\": \"Delete a Klip that is on a tab.\",\n    \"1-1\": \"dashboard.tab\",\n    \"1-0\": \"Permissions\",\n    \"2-0\": \"Resource URL\",\n    \"2-1\": \"`https://app.klipfolio.com/api/1.0/tabs/{id}/klip-instances/`\",\n    \"3-0\": \"Parameters\",\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/tabs/ca12b12345678ie91b2o9c123e89b7bc/klip-instances/c5t8i9abc4ca99613a1bd1bf5c123ce4`\n\n##Example Response\n```\n{\n  \"meta\": {\n    \"success\": true,\n    \"status\": 200\n  },\n  \"data\": {}\n}\n```","excerpt":"A tab (now called dashboard) may have more than one Klip instance associated with it. A Klip instance is a copy of a Klip in a user’s tab.","slug":"tab-klip-instances","type":"basic","title":"Tab Klip Instances"}

Tab Klip Instances

A tab (now called dashboard) may have more than one Klip instance associated with it. A Klip instance is a copy of a Klip in a user’s tab.

[block:api-header] { "type": "get", "title": "GET /tabs/{id}/klip-instances" } [/block] [block:parameters] { "data": { "0-0": "Description", "0-1": "Get a list of the Klip instances associated with the tab.", "1-0": "Permissions", "2-0": "Resource URL", "3-0": "Parameters", "1-1": "dashboard.tab", "2-1": "https://app.klipfolio.com/api/1.0/tabs/{id}/klip-instances", "3-1": "tab id={id}" }, "cols": 2, "rows": 4 } [/block] ##Example Request `GET https://app.klipfolio.com/api/1/tabs/fedcba9876543210fedcba9876543210/klip-instances` ##Example Response ``` { "data": { "klip_instances": [{ "id":"04462abd3a38372173645f3b50128596", "klip_id":"b2f4179cdc4f5a022a80310fe93b1022", "name":"Visits and Goals" }] }, "meta": { "status": 200, "success": true } } ``` [block:api-header] { "type": "put", "title": "PUT /tabs/{id}/klip-instances" } [/block] [block:parameters] { "data": { "0-1": "Add a Klip to a tab. The Klip id is used instead of the Klip instance id. \n*Note:* If region and position are not included, they default to 1 and 0 respectively.", "0-0": "Description", "1-0": "Permissions", "2-0": "Resource URL", "3-0": "Fields", "1-1": "dashboard.tab", "2-1": "https://app.klipfolio.com/api/1.0/tabs/{id}/klip-instances", "3-1": "Klips" }, "cols": 2, "rows": 4 } [/block] ##Example Request `PUT https://app.klipfolio.com/api/1.0/tabs/ca74a78906543be66b2z9c123e76b1bc/klip-instances -d {'klips': [{'klip_id': 'd012d123b56123d1234ef12c8f12c123', 'region': 0, 'position': 1}]}` ##Example Response ``` { "meta": { "success": true, "status": 200 }, "data": { "klip_instances": [ { "id": "12a123c123ef12333cbf7d3d864f674", "klip_id": "d012d123b56123d1234ef12c8f12c123", "name": "Klipfolio API, Client Dynamic, filter Active" } ] } } ``` [block:api-header] { "type": "delete", "title": "DELETE /tabs/{id}/klip-instances/" } [/block] [block:parameters] { "data": { "0-0": "Description", "0-1": "Delete a Klip that is on a tab.", "1-1": "dashboard.tab", "1-0": "Permissions", "2-0": "Resource URL", "2-1": "`https://app.klipfolio.com/api/1.0/tabs/{id}/klip-instances/`", "3-0": "Parameters", "3-1": "None." }, "cols": 2, "rows": 4 } [/block] ##Example Request `DELETE https://app.klipfolio.com/api/1.0/tabs/ca12b12345678ie91b2o9c123e89b7bc/klip-instances/c5t8i9abc4ca99613a1bd1bf5c123ce4` ##Example Response ``` { "meta": { "success": true, "status": 200 }, "data": {} } ```