{"_id":"57ed7a9f5760ab190017b6dd","user":"57d1da1665042a17006686d5","parentDoc":null,"__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"},"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"},"project":"563a252d50bf950d00e09798","updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-09-29T20:33:35.210Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":3,"body":"[block:callout]\n{\n  \"type\": \"warning\",\n  \"title\": \"Application Usage Statistics are currently a beta release\",\n  \"body\": \"To have this feature enabled for your account, contact [success:::at:::klipfolio.com](mailto:success@klipfolio.com).\\n\\n**Note:** Because this is a beta release, some history may not be retained.\"\n}\n[/block]\n[Check out (Beta) Usage Overview for more Application Usage Statistics. ](http://apidocs.klipfolio.com/v1.0/docs/app-stats) \n[block:api-header]\n{\n  \"type\": \"get\",\n  \"title\": \"GET /usage-details/published-link-views\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"Description\",\n    \"0-1\": \"Track every published link view.\",\n    \"1-0\": \"Resource URL\",\n    \"2-0\": \"Required permissions\",\n    \"3-0\": \"Required parameters\",\n    \"4-0\": \"Response codes\",\n    \"1-1\": \"`https://app.klipfolio.com/api/1.0/usage-details/published-link-views`\",\n    \"2-1\": \"account.api\",\n    \"3-1\": \"start_date (Unix time)\\nend_date (Unix time)\\nagg_method: **count, distinct, integral, mean, median, spread, sum**\\ninterval (integer) used to specify the grouping of results in relation to the optional parameter, **units**. If unit is not specified, the default unit is hour.\",\n    \"4-1\": \"**200**—Success\\n**400**—Bad request (missing parameter)\\n**403**—Forbidden (missing permissions)\\n**404**—Not found\",\n    \"5-0\": \"\"\n  },\n  \"cols\": 2,\n  \"rows\": 5\n}\n[/block]\n\n[block:html]\n{\n  \"html\": \"<table style=\\\"width:50%\\\">\\n<tbody>\\n<tr bgcolor=\\\"#F2F2F2\\\">\\n  <td width=\\\"50%\\\"><strong>Optional parameters</strong></td>\\n  <td width=\\\"50%\\\"><strong>Permissions</strong></td>\\n</tr>\\n<tr>\\n\\t<td width=\\\"50%\\\">company_id (string)</td>\\n\\t<td width=\\\"50%\\\">client.access</td>\\n</tr>\\n  <tr>\\n\\t<td width=\\\"50%\\\">unit</br><font size=\\\"1\\\">s (seconds)</br>m (minutes)</br>h (hours)</br>d (days)</br>w (weeks)</font></td>\\n\\t<td width=\\\"50%\\\">no permission</td>\\n</tr>\\n  <tr>\\n\\t<td width=\\\"50%\\\">link_id (string)</td>\\n\\t<td width=\\\"50%\\\">tab.publish</td>\\n</tr>\\n  <tr>\\n\\t<td width=\\\"50%\\\">is_public</td>\\n\\t<td width=\\\"50%\\\">no permission</td>\\n</tr>\\n</tbody>\\n</table>\"\n}\n[/block]\n##Notes:\nIf company_id is not provided, the request will default to the id of the requesting user.\n\nData at the second and minute level are updated instantly. Hourly, daily and weekly level data is updated once every hour.\n\n##Example Request and Response\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"meta\\\": {\\n    \\\"success\\\": true,\\n    \\\"status\\\": 200\\n  },\\n  \\\"data\\\": {\\n    \\\"measurement\\\": \\\"published-link-views\\\",\\n    \\\"agg_method\\\": \\\"SUM\\\",\\n    \\\"interval\\\": 5,\\n    \\\"unit\\\": \\\"m\\\",\\n    \\\"results\\\": [\\n      {\\n        \\\"timestamp\\\": \\\"2016-09-16T00:00:00Z\\\",\\n        \\\"value\\\": 249\\n      },\\n      {\\n        \\\"timestamp\\\": \\\"2016-09-21T00:00:00Z\\\",\\n        \\\"value\\\": 171\\n      }\\n    ]\\n  }\\n}\",\n      \"language\": \"json\",\n      \"name\": \"https://app.klipfolio.com/api/1.0/usage-details/published-link-views?start_date=1473984000&end_date=1474416000&agg_method=sum&interval=5&unit=m\"\n    }\n  ]\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"get\",\n  \"title\": \"GET /usage-details/api-calls\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"Description\",\n    \"0-1\": \"Track every API call.\",\n    \"1-0\": \"Resource URLPermissions\",\n    \"1-1\": \"`https://app.klipfolio.com/api/1.0/usage-details/api-calls`\",\n    \"2-0\": \"Required permissions\",\n    \"2-1\": \"account.api\",\n    \"3-0\": \"Required parameters\",\n    \"3-1\": \"start_date (Unix time)\\nend_date (Unix time)\\nagg_method: **count, distinct, integral, mean, median, spread, sum**\\ninterval (integer) used to specify the grouping of results in relation to the optional parameter, **units**. If unit is not specified, the default unit is hour.\",\n    \"4-0\": \"Response codes\",\n    \"4-1\": \"**200**—Success\\n**400**—Bad request (missing parameter)\\n**403**—Forbidden (missing permissions)\\n**404**—Not found\",\n    \"5-0\": \"\",\n    \"5-1\": \"\"\n  },\n  \"cols\": 2,\n  \"rows\": 5\n}\n[/block]\n\n[block:html]\n{\n  \"html\": \"<table style=\\\"width:50%\\\">\\n<tbody>\\n<tr bgcolor=\\\"#F2F2F2\\\">\\n  <td width=\\\"50%\\\"><strong>Optional parameters</strong></td>\\n  <td width=\\\"50%\\\"><strong>Permissions</strong></td>\\n</tr>\\n<tr>\\n\\t<td width=\\\"50%\\\">company_id (string)</td>\\n\\t<td width=\\\"50%\\\">client.access</td>\\n</tr>\\n  <tr>\\n\\t<td width=\\\"50%\\\">unit</br><font size=\\\"1\\\">s (seconds)</br>m (minutes)</br>h (hours)</br>d (days)</br>w (weeks)</font></td>\\n\\t<td width=\\\"50%\\\">no permission</td>\\n</tr>\\n</tbody>\\n</table>\"\n}\n[/block]\n##Notes:\nIf company_id is not provided, the request will default to the id of the requesting user.\n\nData at the second and minute level are updated instantly. Hourly, daily and weekly level data is updated once every hour.\n\n##Example Request and Response\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"meta\\\": {\\n    \\\"success\\\": true,\\n    \\\"status\\\": 200\\n  },\\n  \\\"data\\\": {\\n    \\\"measurement\\\": \\\"api-calls\\\",\\n    \\\"agg_method\\\": \\\"SUM\\\",\\n    \\\"interval\\\": 5,\\n    \\\"unit\\\": \\\"m\\\",\\n    \\\"results\\\": [\\n      {\\n        \\\"timestamp\\\": \\\"2016-09-16T00:00:00Z\\\",\\n        \\\"value\\\": 923\\n      },\\n      {\\n        \\\"timestamp\\\": \\\"2016-09-21T00:00:00Z\\\",\\n        \\\"value\\\": 871\\n      }\\n    ]\\n  }\\n}\",\n      \"language\": \"json\",\n      \"name\": \" https://app.klipfolio.com/api/1.0/usage-details/api-calls?start_date=1473984000&end_date=1474416000&agg_method=sum&interval=5&unit=m\"\n    }\n  ]\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"get\",\n  \"title\": \"GET /usage-details/api-calls-over-limit\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"Description\",\n    \"1-0\": \"Resource URL\",\n    \"2-0\": \"Required permissions\",\n    \"3-0\": \"Required parameters\",\n    \"4-0\": \"Response codes\",\n    \"1-1\": \"`https://app.klipfolio.com/api/1.0/usage-details/api-calls-over-limits`\",\n    \"2-1\": \"account.api\",\n    \"3-1\": \"start_date (Unix time)\\nend_date (Unix time)\\nagg_method: **count, distinct, integral, mean, median, spread, sum**\\ninterval (integer) used to specify the grouping of results in relation to the optional parameter, **units**. If unit is not specified, the default unit is hour.\",\n    \"0-1\": \"Track the number of API calls over the limit.\",\n    \"4-1\": \"**200**—Success\\n**400**—Bad request (missing parameter)\\n**403**—Forbidden (missing permissions)\\n**404**—Not found\"\n  },\n  \"cols\": 2,\n  \"rows\": 5\n}\n[/block]\n\n[block:html]\n{\n  \"html\": \"<table style=\\\"width:50%\\\">\\n<tbody>\\n<tr bgcolor=\\\"#F2F2F2\\\">\\n  <td width=\\\"50%\\\"><strong>Optional parameters</strong></td>\\n  <td width=\\\"50%\\\"><strong>Permissions</strong></td>\\n</tr>\\n<tr>\\n\\t<td width=\\\"50%\\\">company_id (string)</td>\\n\\t<td width=\\\"50%\\\">client.access</td>\\n</tr>\\n  <tr>\\n\\t<td width=\\\"50%\\\">unit</br><font size=\\\"1\\\">s (seconds)</br>m (minutes)</br>h (hours)</br>d (days)</br>w (weeks)</font></td>\\n\\t<td width=\\\"50%\\\">no permission</td>\\n</tr>\\n</tbody>\\n</table>\"\n}\n[/block]\n##Notes:\nIf company_id is not provided, the request will default to the id of the requesting user.\n\nData at the second and minute level are updated instantly. Hourly, daily and weekly level data is updated once every hour.\n\n##Example Request and Response\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"meta\\\": {\\n    \\\"success\\\": true,\\n    \\\"status\\\": 200\\n  },\\n  \\\"data\\\": {\\n    \\\"measurement\\\": \\\"api-calls-over-limit\\\",\\n    \\\"agg_method\\\": \\\"SUM\\\",\\n    \\\"interval\\\": 5,\\n    \\\"unit\\\": \\\"m\\\",\\n    \\\"results\\\": [\\n      {\\n        \\\"timestamp\\\": \\\"2016-09-16T00:00:00Z\\\",\\n        \\\"value\\\": 12\\n      },\\n      {\\n        \\\"timestamp\\\": \\\"2016-09-21T00:00:00Z\\\",\\n        \\\"value\\\": 23\\n      }\\n    ]\\n  }\\n}\",\n      \"language\": \"json\",\n      \"name\": \" https://app.klipfolio.com/api/1.0/usage-details/api-calls-over-limit?start_date=1473984000&end_date=1474416000&agg_method=sum&interval=5&unit=m\"\n    }\n  ]\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"get\",\n  \"title\": \"GET/usage-details/dashboard-views\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"Description\",\n    \"1-0\": \"Resource URL\",\n    \"2-0\": \"Required permissions\",\n    \"3-0\": \"Required parameters\",\n    \"4-0\": \"Response Codes\",\n    \"1-1\": \"`https://app.klipfolio.com/api/1.0/usage-details/dashboard-views`\",\n    \"2-1\": \"account.api\",\n    \"3-1\": \"start_date (Unix time)\\nend_date (Unix time)\\nagg_method: **count, distinct, integral, mean, median, spread, sum**\\ninterval (integer) used to specify the grouping of results in relation to the optional parameter, **units**. If unit is not specified, the default unit is hour.\",\n    \"4-1\": \"**200**—Success\\n**400**—Bad request (missing parameter)\\n**403**—Forbidden (missing permissions)\\n**404**—Not found\",\n    \"0-1\": \"Track dashboard views by user.\"\n  },\n  \"cols\": 2,\n  \"rows\": 5\n}\n[/block]\n\n[block:html]\n{\n  \"html\": \"<table style=\\\"width:50%\\\">\\n<tbody>\\n<tr bgcolor=\\\"#F2F2F2\\\">\\n  <td width=\\\"50%\\\"><strong>Optional parameters</strong></td>\\n  <td width=\\\"50%\\\"><strong>Permissions</strong></td>\\n</tr>\\n<tr>\\n\\t<td width=\\\"50%\\\">company_id (string)</td>\\n\\t<td width=\\\"50%\\\">client.access</td>\\n</tr>\\n  <tr>\\n\\t<td width=\\\"50%\\\">unit</br><font size=\\\"1\\\">s (seconds)</br>m (minutes)</br>h (hours)</br>d (days)</br>w (weeks)</font></td>\\n\\t<td width=\\\"50%\\\">no permission</td>\\n</tr>\\n  <tr>\\n\\t<td width=\\\"50%\\\">user_id</td>\\n\\t<td width=\\\"50%\\\"></td>\\n</tr>\\n  <tr>\\n\\t<td width=\\\"50%\\\">dashboard_id</td>\\n\\t<td width=\\\"50%\\\"></td>\\n</tr>\\n</tbody>\\n</table>\"\n}\n[/block]\n##Notes:\nIf company_id is not provided, the request will default to the id of the requesting user.\n\nData at the second and minute level are updated instantly. Hourly, daily and weekly level data is updated once every hour.\n\n##Example Request and Response\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"meta\\\": {\\n    \\\"success\\\": true,\\n    \\\"status\\\": 200\\n  },\\n  \\\"data\\\": {\\n    \\\"measurement\\\": \\\"dashboard-views\\\",\\n    \\\"agg_method\\\": \\\"SUM\\\",\\n    \\\"interval\\\": 5,\\n    \\\"unit\\\": \\\"m\\\",\\n    \\\"results\\\": [\\n      {\\n        \\\"timestamp\\\": \\\"2016-09-16T00:00:00Z\\\",\\n        \\\"value\\\": 149\\n      },\\n      {\\n        \\\"timestamp\\\": \\\"2016-09-21T00:00:00Z\\\",\\n        \\\"value\\\": 271\\n      }\\n    ]\\n  }\\n}\",\n      \"language\": \"json\",\n      \"name\": \" https://app.klipfolio.com/api/1.0/usage-details/dashboard-views?start_date=1473984000&end_date=1474416000&agg_method=sum&interval=5&unit=d\"\n    }\n  ]\n}\n[/block]","excerpt":"Access information on account trends and usage.","slug":"usage-details","type":"basic","title":"Beta: Usage Details"}

Beta: Usage Details

Access information on account trends and usage.

[block:callout] { "type": "warning", "title": "Application Usage Statistics are currently a beta release", "body": "To have this feature enabled for your account, contact [success@klipfolio.com](mailto:success@klipfolio.com).\n\n**Note:** Because this is a beta release, some history may not be retained." } [/block] [Check out (Beta) Usage Overview for more Application Usage Statistics. ](http://apidocs.klipfolio.com/v1.0/docs/app-stats) [block:api-header] { "type": "get", "title": "GET /usage-details/published-link-views" } [/block] [block:parameters] { "data": { "0-0": "Description", "0-1": "Track every published link view.", "1-0": "Resource URL", "2-0": "Required permissions", "3-0": "Required parameters", "4-0": "Response codes", "1-1": "`https://app.klipfolio.com/api/1.0/usage-details/published-link-views`", "2-1": "account.api", "3-1": "start_date (Unix time)\nend_date (Unix time)\nagg_method: **count, distinct, integral, mean, median, spread, sum**\ninterval (integer) used to specify the grouping of results in relation to the optional parameter, **units**. If unit is not specified, the default unit is hour.", "4-1": "**200**—Success\n**400**—Bad request (missing parameter)\n**403**—Forbidden (missing permissions)\n**404**—Not found", "5-0": "" }, "cols": 2, "rows": 5 } [/block] [block:html] { "html": "<table style=\"width:50%\">\n<tbody>\n<tr bgcolor=\"#F2F2F2\">\n <td width=\"50%\"><strong>Optional parameters</strong></td>\n <td width=\"50%\"><strong>Permissions</strong></td>\n</tr>\n<tr>\n\t<td width=\"50%\">company_id (string)</td>\n\t<td width=\"50%\">client.access</td>\n</tr>\n <tr>\n\t<td width=\"50%\">unit</br><font size=\"1\">s (seconds)</br>m (minutes)</br>h (hours)</br>d (days)</br>w (weeks)</font></td>\n\t<td width=\"50%\">no permission</td>\n</tr>\n <tr>\n\t<td width=\"50%\">link_id (string)</td>\n\t<td width=\"50%\">tab.publish</td>\n</tr>\n <tr>\n\t<td width=\"50%\">is_public</td>\n\t<td width=\"50%\">no permission</td>\n</tr>\n</tbody>\n</table>" } [/block] ##Notes: If company_id is not provided, the request will default to the id of the requesting user. Data at the second and minute level are updated instantly. Hourly, daily and weekly level data is updated once every hour. ##Example Request and Response [block:code] { "codes": [ { "code": "{\n \"meta\": {\n \"success\": true,\n \"status\": 200\n },\n \"data\": {\n \"measurement\": \"published-link-views\",\n \"agg_method\": \"SUM\",\n \"interval\": 5,\n \"unit\": \"m\",\n \"results\": [\n {\n \"timestamp\": \"2016-09-16T00:00:00Z\",\n \"value\": 249\n },\n {\n \"timestamp\": \"2016-09-21T00:00:00Z\",\n \"value\": 171\n }\n ]\n }\n}", "language": "json", "name": "https://app.klipfolio.com/api/1.0/usage-details/published-link-views?start_date=1473984000&end_date=1474416000&agg_method=sum&interval=5&unit=m" } ] } [/block] [block:api-header] { "type": "get", "title": "GET /usage-details/api-calls" } [/block] [block:parameters] { "data": { "0-0": "Description", "0-1": "Track every API call.", "1-0": "Resource URLPermissions", "1-1": "`https://app.klipfolio.com/api/1.0/usage-details/api-calls`", "2-0": "Required permissions", "2-1": "account.api", "3-0": "Required parameters", "3-1": "start_date (Unix time)\nend_date (Unix time)\nagg_method: **count, distinct, integral, mean, median, spread, sum**\ninterval (integer) used to specify the grouping of results in relation to the optional parameter, **units**. If unit is not specified, the default unit is hour.", "4-0": "Response codes", "4-1": "**200**—Success\n**400**—Bad request (missing parameter)\n**403**—Forbidden (missing permissions)\n**404**—Not found", "5-0": "", "5-1": "" }, "cols": 2, "rows": 5 } [/block] [block:html] { "html": "<table style=\"width:50%\">\n<tbody>\n<tr bgcolor=\"#F2F2F2\">\n <td width=\"50%\"><strong>Optional parameters</strong></td>\n <td width=\"50%\"><strong>Permissions</strong></td>\n</tr>\n<tr>\n\t<td width=\"50%\">company_id (string)</td>\n\t<td width=\"50%\">client.access</td>\n</tr>\n <tr>\n\t<td width=\"50%\">unit</br><font size=\"1\">s (seconds)</br>m (minutes)</br>h (hours)</br>d (days)</br>w (weeks)</font></td>\n\t<td width=\"50%\">no permission</td>\n</tr>\n</tbody>\n</table>" } [/block] ##Notes: If company_id is not provided, the request will default to the id of the requesting user. Data at the second and minute level are updated instantly. Hourly, daily and weekly level data is updated once every hour. ##Example Request and Response [block:code] { "codes": [ { "code": "{\n \"meta\": {\n \"success\": true,\n \"status\": 200\n },\n \"data\": {\n \"measurement\": \"api-calls\",\n \"agg_method\": \"SUM\",\n \"interval\": 5,\n \"unit\": \"m\",\n \"results\": [\n {\n \"timestamp\": \"2016-09-16T00:00:00Z\",\n \"value\": 923\n },\n {\n \"timestamp\": \"2016-09-21T00:00:00Z\",\n \"value\": 871\n }\n ]\n }\n}", "language": "json", "name": " https://app.klipfolio.com/api/1.0/usage-details/api-calls?start_date=1473984000&end_date=1474416000&agg_method=sum&interval=5&unit=m" } ] } [/block] [block:api-header] { "type": "get", "title": "GET /usage-details/api-calls-over-limit" } [/block] [block:parameters] { "data": { "0-0": "Description", "1-0": "Resource URL", "2-0": "Required permissions", "3-0": "Required parameters", "4-0": "Response codes", "1-1": "`https://app.klipfolio.com/api/1.0/usage-details/api-calls-over-limits`", "2-1": "account.api", "3-1": "start_date (Unix time)\nend_date (Unix time)\nagg_method: **count, distinct, integral, mean, median, spread, sum**\ninterval (integer) used to specify the grouping of results in relation to the optional parameter, **units**. If unit is not specified, the default unit is hour.", "0-1": "Track the number of API calls over the limit.", "4-1": "**200**—Success\n**400**—Bad request (missing parameter)\n**403**—Forbidden (missing permissions)\n**404**—Not found" }, "cols": 2, "rows": 5 } [/block] [block:html] { "html": "<table style=\"width:50%\">\n<tbody>\n<tr bgcolor=\"#F2F2F2\">\n <td width=\"50%\"><strong>Optional parameters</strong></td>\n <td width=\"50%\"><strong>Permissions</strong></td>\n</tr>\n<tr>\n\t<td width=\"50%\">company_id (string)</td>\n\t<td width=\"50%\">client.access</td>\n</tr>\n <tr>\n\t<td width=\"50%\">unit</br><font size=\"1\">s (seconds)</br>m (minutes)</br>h (hours)</br>d (days)</br>w (weeks)</font></td>\n\t<td width=\"50%\">no permission</td>\n</tr>\n</tbody>\n</table>" } [/block] ##Notes: If company_id is not provided, the request will default to the id of the requesting user. Data at the second and minute level are updated instantly. Hourly, daily and weekly level data is updated once every hour. ##Example Request and Response [block:code] { "codes": [ { "code": "{\n \"meta\": {\n \"success\": true,\n \"status\": 200\n },\n \"data\": {\n \"measurement\": \"api-calls-over-limit\",\n \"agg_method\": \"SUM\",\n \"interval\": 5,\n \"unit\": \"m\",\n \"results\": [\n {\n \"timestamp\": \"2016-09-16T00:00:00Z\",\n \"value\": 12\n },\n {\n \"timestamp\": \"2016-09-21T00:00:00Z\",\n \"value\": 23\n }\n ]\n }\n}", "language": "json", "name": " https://app.klipfolio.com/api/1.0/usage-details/api-calls-over-limit?start_date=1473984000&end_date=1474416000&agg_method=sum&interval=5&unit=m" } ] } [/block] [block:api-header] { "type": "get", "title": "GET/usage-details/dashboard-views" } [/block] [block:parameters] { "data": { "0-0": "Description", "1-0": "Resource URL", "2-0": "Required permissions", "3-0": "Required parameters", "4-0": "Response Codes", "1-1": "`https://app.klipfolio.com/api/1.0/usage-details/dashboard-views`", "2-1": "account.api", "3-1": "start_date (Unix time)\nend_date (Unix time)\nagg_method: **count, distinct, integral, mean, median, spread, sum**\ninterval (integer) used to specify the grouping of results in relation to the optional parameter, **units**. If unit is not specified, the default unit is hour.", "4-1": "**200**—Success\n**400**—Bad request (missing parameter)\n**403**—Forbidden (missing permissions)\n**404**—Not found", "0-1": "Track dashboard views by user." }, "cols": 2, "rows": 5 } [/block] [block:html] { "html": "<table style=\"width:50%\">\n<tbody>\n<tr bgcolor=\"#F2F2F2\">\n <td width=\"50%\"><strong>Optional parameters</strong></td>\n <td width=\"50%\"><strong>Permissions</strong></td>\n</tr>\n<tr>\n\t<td width=\"50%\">company_id (string)</td>\n\t<td width=\"50%\">client.access</td>\n</tr>\n <tr>\n\t<td width=\"50%\">unit</br><font size=\"1\">s (seconds)</br>m (minutes)</br>h (hours)</br>d (days)</br>w (weeks)</font></td>\n\t<td width=\"50%\">no permission</td>\n</tr>\n <tr>\n\t<td width=\"50%\">user_id</td>\n\t<td width=\"50%\"></td>\n</tr>\n <tr>\n\t<td width=\"50%\">dashboard_id</td>\n\t<td width=\"50%\"></td>\n</tr>\n</tbody>\n</table>" } [/block] ##Notes: If company_id is not provided, the request will default to the id of the requesting user. Data at the second and minute level are updated instantly. Hourly, daily and weekly level data is updated once every hour. ##Example Request and Response [block:code] { "codes": [ { "code": "{\n \"meta\": {\n \"success\": true,\n \"status\": 200\n },\n \"data\": {\n \"measurement\": \"dashboard-views\",\n \"agg_method\": \"SUM\",\n \"interval\": 5,\n \"unit\": \"m\",\n \"results\": [\n {\n \"timestamp\": \"2016-09-16T00:00:00Z\",\n \"value\": 149\n },\n {\n \"timestamp\": \"2016-09-21T00:00:00Z\",\n \"value\": 271\n }\n ]\n }\n}", "language": "json", "name": " https://app.klipfolio.com/api/1.0/usage-details/dashboard-views?start_date=1473984000&end_date=1474416000&agg_method=sum&interval=5&unit=d" } ] } [/block]