{"_id":"57a23072d778850e0047e3a8","__v":1,"parentDoc":null,"user":"54c7fdeae317000d007c2765","project":"563a252d50bf950d00e09798","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"},"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"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-08-03T17:57:06.942Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"settings":"","results":{"codes":[]},"auth":"required","params":[],"url":""},"isReference":false,"order":7,"body":"[block:api-header]\n{\n  \"type\": \"get\",\n  \"title\": \"GET /clients/{id}/resources\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"Description\",\n    \"0-1\": \"Lists all resources (dashboards, Klips, data sources, API resources, private links, concurrent sessions) allocated to a specified client. Users with admin role privileges have access to all clients.\",\n    \"1-0\": \"Permissions\",\n    \"2-0\": \"Resource URL\",\n    \"3-0\": \"Parameters\",\n    \"1-1\": \"client.access\",\n    \"2-1\": \"https://app.klipfolio.com/api/1.0/clients{id}/resources\",\n    \"3-1\": \"id (string) — client id\\nfull (true/false) — include resources (API Calls per Day, API Calls per Second, API Append Data Size (in KB), Klips per Dashboard,\\nMaximum viewable Dashboards, Dashboards, Data Sources per Formula, Users, Concurrent Sessions, Private Links)\"\n  },\n  \"cols\": 2,\n  \"rows\": 4\n}\n[/block]\n## Example Request \n\nGET https://app.klipfolio.com/api/1.0/clients/7117c12053e064e6e05c5bfbddd9bab4/resources\n\n## Example Response \n\n```\n{\n  \"meta\": {\n    \"success\": true,\n    \"status\": 200\n  },\n  \"data\": {\n    \"resources\": [\n      {\n        \"name\": \"API Calls per Day\",\n        \"value\": 10000\n      },\n      {\n        \"name\": \"API Calls per Second\",\n        \"value\": 5\n      },\n      {\n        \"name\": \"API Append Data Size (in KB)\",\n        \"value\": 10240\n      },\n      {\n        \"name\": \"Klips per Dashboard\",\n        \"value\": 30\n      },\n      {\n        \"name\": \"Maximum viewable Dashboards\",\n        \"value\": 60\n      },\n      {\n        \"name\": \"Dashboards\",\n        \"value\": -1\n      },\n      {\n        \"name\": \"Data Sources per Formula\",\n        \"value\": 12\n      },\n      {\n        \"name\": \"Users\",\n        \"value\": 3\n      },\n      {\n        \"name\": \"Concurrent Sessions\",\n        \"value\": 2\n      },\n      {\n        \"name\": \"Private Links\",\n        \"value\": 0\n      },\n      {\n        \"name\": \"Private Link Viewers\",\n        \"value\": 100\n      }\n    ]\n  }\n}\n```\n\n[block:api-header]\n{\n  \"type\": \"put\",\n  \"title\": \"PUT/clients/{id}/resources\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"Description\",\n    \"0-1\": \"Update the specified resource. Users with admin role privileges have access to all clients.\",\n    \"1-0\": \"Permissions\",\n    \"1-1\": \"client.edit\",\n    \"2-0\": \"Resource URL\",\n    \"2-1\": \"https://app.klipfolio.com/api/1.0/clients/{id}/resources\",\n    \"3-0\": \"Fields\",\n    \"3-1\": \"Resource names: \\napi.requests.perSecond\\napi.append.data.size\\ndashboard.klips.perTab\\ndashboard.tabs.perDashboard\\ndashboard.tabs.total\\nworkspace.datasources.perFormula\\ncompany.seats\\nsessions.concurrent\\npublished.private.links\\npublished.private.concurrent\"\n  },\n  \"cols\": 2,\n  \"rows\": 4\n}\n[/block]\n##Example Request\nhttps://app.klipfolio.com/api/1.0/clients/7117c12053e064e6e05c5bfbddd9bab4/resources -d\n\"resources\": [{\"name\":\"published.private.links\", \"value\":7}]\n\n##Example Response\n```\n{\n  \"meta\": {\n    \"success\": true,\n    \"status\": 200\n  },\n  \"data\": {}\n}\n```","excerpt":"View and update client resources for all client accounts belonging to the requesting company.","slug":"client-resources","type":"basic","title":"Client Resources"}

Client Resources

View and update client resources for all client accounts belonging to the requesting company.

[block:api-header] { "type": "get", "title": "GET /clients/{id}/resources" } [/block] [block:parameters] { "data": { "0-0": "Description", "0-1": "Lists all resources (dashboards, Klips, data sources, API resources, private links, concurrent sessions) allocated to a specified client. Users with admin role privileges have access to all clients.", "1-0": "Permissions", "2-0": "Resource URL", "3-0": "Parameters", "1-1": "client.access", "2-1": "https://app.klipfolio.com/api/1.0/clients{id}/resources", "3-1": "id (string) — client id\nfull (true/false) — include resources (API Calls per Day, API Calls per Second, API Append Data Size (in KB), Klips per Dashboard,\nMaximum viewable Dashboards, Dashboards, Data Sources per Formula, Users, Concurrent Sessions, Private Links)" }, "cols": 2, "rows": 4 } [/block] ## Example Request GET https://app.klipfolio.com/api/1.0/clients/7117c12053e064e6e05c5bfbddd9bab4/resources ## Example Response ``` { "meta": { "success": true, "status": 200 }, "data": { "resources": [ { "name": "API Calls per Day", "value": 10000 }, { "name": "API Calls per Second", "value": 5 }, { "name": "API Append Data Size (in KB)", "value": 10240 }, { "name": "Klips per Dashboard", "value": 30 }, { "name": "Maximum viewable Dashboards", "value": 60 }, { "name": "Dashboards", "value": -1 }, { "name": "Data Sources per Formula", "value": 12 }, { "name": "Users", "value": 3 }, { "name": "Concurrent Sessions", "value": 2 }, { "name": "Private Links", "value": 0 }, { "name": "Private Link Viewers", "value": 100 } ] } } ``` [block:api-header] { "type": "put", "title": "PUT/clients/{id}/resources" } [/block] [block:parameters] { "data": { "0-0": "Description", "0-1": "Update the specified resource. Users with admin role privileges have access to all clients.", "1-0": "Permissions", "1-1": "client.edit", "2-0": "Resource URL", "2-1": "https://app.klipfolio.com/api/1.0/clients/{id}/resources", "3-0": "Fields", "3-1": "Resource names: \napi.requests.perSecond\napi.append.data.size\ndashboard.klips.perTab\ndashboard.tabs.perDashboard\ndashboard.tabs.total\nworkspace.datasources.perFormula\ncompany.seats\nsessions.concurrent\npublished.private.links\npublished.private.concurrent" }, "cols": 2, "rows": 4 } [/block] ##Example Request https://app.klipfolio.com/api/1.0/clients/7117c12053e064e6e05c5bfbddd9bab4/resources -d "resources": [{"name":"published.private.links", "value":7}] ##Example Response ``` { "meta": { "success": true, "status": 200 }, "data": {} } ```