{"_id":"57e9b7c86cb27c0e005ed629","parentDoc":null,"project":"563a252d50bf950d00e09798","__v":2,"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"},"user":"57d1da1665042a17006686d5","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":["580a61b57c3ac50f00279d27"],"next":{"pages":[],"description":""},"createdAt":"2016-09-27T00:05:28.276Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"settings":"","results":{"codes":[]},"auth":"required","params":[],"url":""},"isReference":false,"order":2,"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\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Some Application Usage Statistics are available based on your plan\",\n  \"body\": \"Some Usage Overview endpoints are only available to users on plans: **Grow** and above.\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Data\",\n    \"h-1\": \"Plan\",\n    \"0-0\": \"Daily client trend\",\n    \"1-0\": \"Monthly client aggregate\",\n    \"2-0\": \"Account sign-in trend\",\n    \"3-0\": \"User sign-in trend\",\n    \"0-1\": \"Grow and above\",\n    \"1-1\": \"Grow and above\",\n    \"2-1\": \"Grow and above\",\n    \"3-1\": \"Grow and above\"\n  },\n  \"cols\": 2,\n  \"rows\": 4\n}\n[/block]\n[Check out (Beta) Usage Details for more Application Usage Statistics. ](http://apidocs.klipfolio.com/v1.0/docs/usage-details) \n[block:api-header]\n{\n  \"type\": \"get\",\n  \"title\": \"GET /usage-overview/account-stats\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"Description\",\n    \"0-1\": \"A report of client activity and growth over time.\",\n    \"1-0\": \"Resource URL\",\n    \"2-0\": \"Required permissions\",\n    \"1-1\": \"`https://app.klipfolio.com/api/1.0/usage-overview/account-stats`\",\n    \"2-1\": \"account.api\",\n    \"3-0\": \"Required parameters\",\n    \"3-1\": \"start_date (Unix time)\\nend_date (Unix time)\",\n    \"4-1\": \"**200**—Success\\n**400**—Bad request (missing parameter)\\n**403**—Forbidden (missing permissions)\\n**404**—Not found\",\n    \"4-0\": \"Response codes\"\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</tbody>\\n</table>\\n<p>Note: If company_id is not provided, the request will default to the id of the requesting user.</p>\"\n}\n[/block]\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    \\\"overview\\\": [\\n      {\\n        \\\"calendar_date\\\": \\\"2016-09-27\\\",\\n        \\\"last_login_calendar_date\\\": \\\"2016-09-23\\\",\\n        \\\"no_of_seats\\\": \\\"3\\\",\\n        \\\"no_of_users\\\": \\\"2\\\",\\n        \\\"no_of_klips\\\": \\\"18\\\",\\n        \\\"no_of_data_sources\\\": \\\"19\\\",\\n        \\\"no_of_scheduled_emails\\\": \\\"4\\\",\\n        \\\"no_of_dashboards\\\": \\\"5\\\",\\n        \\\"no_of_klip_templates\\\": \\\"5\\\",\\n        \\\"no_of_embeds\\\": \\\"4\\\",\\n        \\\"data_storage_size\\\": \\\"2991\\\"\\n      },\\n      {\\n        \\\"calendar_date\\\": \\\"2016-09-28\\\",\\n        \\\"last_login_calendar_date\\\": \\\"2016-09-23\\\",\\n        \\\"no_of_seats\\\": \\\"3\\\",\\n        \\\"no_of_users\\\": \\\"2\\\",\\n        \\\"no_of_klips\\\": \\\"18\\\",\\n        \\\"no_of_data_sources\\\": \\\"19\\\",\\n        \\\"no_of_scheduled_emails\\\": \\\"4\\\",\\n        \\\"no_of_dashboards\\\": \\\"5\\\",\\n        \\\"no_of_klip_templates\\\": \\\"5\\\",\\n        \\\"no_of_embeds\\\": \\\"4\\\",\\n        \\\"data_storage_size\\\": \\\"2885\\\"\\n      }\\n    ]\\n  }\\n}\",\n      \"language\": \"json\",\n      \"name\": \"https://app.klipfolio.com/api/1/usage-overview/account-stats?start_date=1474991873&end_date=1475078273\"\n    }\n  ]\n}\n[/block]\n##Response Fields\n`last_login_calendar_date`: The date the account was last logged into.\n`calendar_date`: The date.\n`no_of_seats`: Number of seats assigned to the company.\n`no_of_users`: Number of users existing in the company.\n`no_of_klips`: Number of Klips existing in the company.\n`no_of_data_sources`: Number of data sources existing in the company.\n`no_of_scheduled_emails`: Number of scheduled emails existing in the company.\n`no_of_dashboards`: Number of dashboards existing in the company.\n`no_of_klip_templates`: Number of Klip templates being used by the company.\n`no_of_embeds`: Number of embeds existing in the company.\n`data_storage_size`: Total data storage size (in bytes).\n\n[block:api-header]\n{\n  \"type\": \"get\",\n  \"title\": \"GET /usage-overview/data-source-stats\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"Description\",\n    \"0-1\": \"The number of data sources and dynamic data source instances by service and account.\",\n    \"1-0\": \"Resource URL\",\n    \"1-1\": \"`https://app.klipfolio.com/api/1.0/usage-overview/data-source-stats`\",\n    \"2-0\": \"Required permissions\",\n    \"2-1\": \"account.api\",\n    \"5-0\": \"Returned response fields\",\n    \"6-0\": \"\",\n    \"5-1\": \"\",\n    \"6-1\": \"\",\n    \"4-1\": \"**200**—Success\\n**400**—Bad request (missing parameter)\\n**403**—Forbidden (missing permissions)\\n**404**—Not found\",\n    \"4-0\": \"Response codes\",\n    \"3-0\": \"Required parameters\",\n    \"3-1\": \"start_date (Unix time)\\nend_date (Unix time)\"\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</tbody>\\n</table>\\n<p>Note: If company_id is not provided, the request will default to the id of the requesting user.</p>\"\n}\n[/block]\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    \\\"overview\\\": [\\n    \\t{\\n        \\\"company_name\\\": \\\"Acme\\\",\\n        \\\"calendar_date\\\": \\\"2017-04-01\\\",\\n        \\\"service_name\\\": \\\"Google Analytics\\\",\\n        \\\"connector_name\\\": \\\"Website Performance\\\",\\n        \\\"type_name\\\": \\\"google_analytics\\\",\\n        \\\"no_of_datasources\\\": \\\"6\\\",\\n        \\\"no_of_instances\\\": \\\"8\\\"\\n      },\\n      {\\n        \\\"company_name\\\": \\\"Acme\\\",\\n        \\\"calendar_date\\\": \\\"2017-04-01\\\",\\n        \\\"service_name\\\": \\\"Google Search Console\\\",\\n        \\\"connector_name\\\": \\\"Sites\\\",\\n        \\\"type_name\\\": \\\"simple_rest\\\",\\n        \\\"no_of_datasources\\\": \\\"2\\\",\\n        \\\"no_of_instances\\\": \\\"5\\\"\\n      },\\n      {\\n        \\\"company_name\\\": \\\"Acme\\\",\\n        \\\"calendar_date\\\": \\\"2017-04-02\\\",\\n        \\\"service_name\\\": \\\"Google Analytics\\\",\\n        \\\"connector_name\\\": \\\"Website Performance\\\",\\n        \\\"type_name\\\": \\\"google_analytics\\\",\\n        \\\"no_of_datasources\\\": \\\"6\\\",\\n        \\\"no_of_instances\\\": \\\"8\\\"\\n      },\\n      {\\n        \\\"company_name\\\": \\\"Acme\\\",\\n        \\\"calendar_date\\\": \\\"2017-04-02\\\",\\n        \\\"service_name\\\": \\\"Not Available\\\",\\n        \\\"connector_name\\\": \\\"Not Available\\\",\\n        \\\"type_name\\\": \\\"google_adwords\\\",\\n        \\\"no_of_datasources\\\": \\\"1\\\",\\n        \\\"no_of_instances\\\": \\\"1\\\"\\n      }\\n    ]\\n  }\\n}\",\n      \"language\": \"json\",\n      \"name\": \"https://app.klipfolio.com/api/1.0/usage-overview/data-source-stats?start_date=1491004800&end_date=1491091200\"\n    }\n  ]\n}\n[/block]\n##Response Fields\n`company_name`: The company name.\n`calendar_date`: The date.\n`service_name`: Service of this data source.\n`connector_name`: Connector service name.\n`type_name`: Type name.\n`no_of_datasources`: Count of datasources for this service/connector/type.\n`no_of_instances`: Count of datasource instances for this service/connector/type.\n\n**Note**: If `service_name` or `connector_name` returns as **Not Available**, it is referring to a service that is not in the Connector Gallery.\n[block:api-header]\n{\n  \"type\": \"get\",\n  \"title\": \"GET/usage-overview/api-usage\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"Description\",\n    \"1-0\": \"Resource URL\",\n    \"1-1\": \"`https://app.klipfolio.com/api/1.0/usage-overview/api-usage`\",\n    \"0-1\": \"A report of API calls and limits reached per day.\",\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    \"2-0\": \"Required Permissions\",\n    \"3-0\": \"Required Parameters\",\n    \"2-1\": \"account.api\",\n    \"3-1\": \"start_date (Unix time)\\nend_date (Unix time)\"\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</tbody>\\n</table>\\n<p>Note: If company_id is not provided, the request will default to the id of the requesting user.</p>\"\n}\n[/block]\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    \\\"overview\\\": [\\n      {\\n        \\\"calendar_date\\\": \\\"2016-09-01\\\",\\n        \\\"api_usage\\\": \\\"24\\\",\\n        \\\"api_limit\\\": \\\"1000\\\"\\n      },\\n      {\\n        \\\"calendar_date\\\": \\\"2016-09-02\\\",\\n        \\\"api_usage\\\": \\\"12\\\",\\n        \\\"api_limit\\\": \\\"1000\\\"\\n      },\\n      {\\n        \\\"calendar_date\\\": \\\"2016-09-03\\\",\\n        \\\"api_usage\\\": \\\"6\\\",\\n        \\\"api_limit\\\": \\\"1000\\\"\\n      }\\n    ]\\n  }\\n}\",\n      \"language\": \"json\",\n      \"name\": \"https://app.klipfolio.com/api/1.0/usage-overview/api-usage?start_date=1472739034&end_date=1472930407\"\n    }\n  ]\n}\n[/block]\n##Response Fields\n`calendar_date`: The date.\n`api_usage`: API calls consumed that day.\n`api_limit`: Company limit that day.\n[block:api-header]\n{\n  \"type\": \"get\",\n  \"title\": \"GET/usage-overview/published-links\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"4-1\": \"**200**—Success\\n**400**—Bad request (missing parameter)\\n**403**—Forbidden (missing permissions)\\n**404**—Not found\",\n    \"3-1\": \"start_date (Unix time)\\nend_date (Unix time)\",\n    \"2-1\": \"account.api\",\n    \"1-1\": \"`https://app.klipfolio.com/api/1.0/usage-overview/published-links`\",\n    \"0-1\": \"A count on how many views a published link has per hour.\",\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  },\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</tbody>\\n</table>\\n<p>Note: If company_id is not provided, the request will default to the id of the requesting user.</p>\"\n}\n[/block]\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        \\\"overview\\\": [{\\n            \\\"calendar_date\\\": \\\"2016-09-01\\\",\\n            \\\"time\\\": \\\"1:0:0\\\",\\n            \\\"name\\\": \\\"Marketing\\\",\\n            \\\"is_public\\\": \\\"No\\\",\\n            \\\"is_disabled\\\": \\\"No\\\",\\n            \\\"has_password\\\": \\\"No\\\",\\n            \\\"view_count\\\": \\\"29\\\"\\n        },\\n        {\\n            \\\"calendar_date\\\": \\\"2016-09-01\\\",\\n            \\\"time\\\": \\\"1:0:0\\\",\\n            \\\"name\\\": \\\"Sales\\\",\\n            \\\"is_public\\\": \\\"No\\\",\\n            \\\"is_disabled\\\": \\\"No\\\",\\n            \\\"has_password\\\": \\\"No\\\",\\n            \\\"view_count\\\": \\\"33\\\"\\n        },\\n        {\\n            \\\"calendar_date\\\": \\\"2016-09-01\\\",\\n            \\\"time\\\": \\\"1:0:0\\\",\\n            \\\"name\\\": \\\"Social Media\\\",\\n            \\\"is_public\\\": \\\"No\\\",\\n            \\\"is_disabled\\\": \\\"No\\\",\\n            \\\"has_password\\\": \\\"No\\\",\\n            \\\"view_count\\\": \\\"17\\\"\\n        },\\n        {\",\n      \"language\": \"json\",\n      \"name\": \"https://app.klipfolio.com/api/1.0/usage-overview/published-links?start_date=1472739034&end_date=1472774400\"\n    }\n  ]\n}\n[/block]\n#Response Fields\n`calendar_date`: The date.\n`time`: The time in h: m :s.\n`name`: dashboard name\n`is_public`: Yes or no response indicating whether the link is public. \n`is_disabled`: Yes or no response indicating whether the link is disabled. \n`has_password`: Yes or no response indicating whether the link has a password. \n`view_count`: Number of views that hour.\n[block:api-header]\n{\n  \"title\": \"GET/usage-overview/daily-client-trend\"\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Available for plans: Grow and above\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"Description\",\n    \"1-0\": \"Resource URL\",\n    \"4-0\": \"Response Codes\",\n    \"1-1\": \"`https://app.klipfolio.com/api/1.0/usage-overview/daily-client-trend`\",\n    \"0-1\": \"A report of client additions and cancellations per day.\",\n    \"4-1\": \"**200**—Success\\n**400**—Bad request (missing parameter)\\n**403**—Forbidden (missing permissions)\\n**404**—Not found\",\n    \"2-0\": \"Required Permissions\",\n    \"3-0\": \"Required Parameters\",\n    \"2-1\": \"account.api\",\n    \"3-1\": \"start_date (Unix time)\\nend_date (Unix time)\"\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</tbody>\\n</table>\\n<p>Note: If company_id is not provided, the request will default to the id of the requesting user.</p>\"\n}\n[/block]\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    \\\"overview\\\": [\\n      {\\n        \\\"calendar_date\\\": \\\"2016-09-01\\\",\\n        \\\"added\\\": \\\"1\\\",\\n        \\\"cancelled\\\":\\\"0\\\"\\n      }\\n      {\\n       \\\"calendar_date\\\": \\\"2016-09-02\\\",\\n        \\\"added\\\": \\\"1\\\",\\n        \\\"cancelled\\\":\\\"1\\\"\\n      }\\n     ] \\n    }\\n\\t}     \",\n      \"language\": \"json\",\n      \"name\": \"https://app.klipfolio.com/api/1.0/usage-overview/daily-client-trend?start_date=1472739034&end_date=1472832859\"\n    }\n  ]\n}\n[/block]\n##Response Fields\n`calendar_date`: The date.\n`added`: Number of clients added that day.\n`cancelled`: Number of clients removed that day.\n[block:api-header]\n{\n  \"type\": \"get\",\n  \"title\": \"GET/usage-overview/monthly-client-aggregate\"\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Available for plans: Grow and above\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"Description\",\n    \"1-0\": \"Resource URL\",\n    \"4-0\": \"Response Codes\",\n    \"1-1\": \"`https://app.klipfolio.com/api/1.0/usage-overview/monthly-client-aggregate`\",\n    \"4-1\": \"**200**—Success\\n**400**—Bad request (missing parameter)\\n**403**—Forbidden (missing permissions)\\n**404**—Not found\",\n    \"0-1\": \"A monthly overview of client trends and activity.\",\n    \"2-0\": \"Required Permissions\",\n    \"3-0\": \"Required Parameters\",\n    \"2-1\": \"account.api\",\n    \"3-1\": \"start_date (Unix time)\\nend_date (Unix time)\"\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</tbody>\\n</table>\\n<p>Note: If company_id is not provided, the request will default to the id of the requesting user.</p>\"\n}\n[/block]\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    \\\"overview\\\": [\\n      {\\n        \\\"calendar_date\\\": \\\"2016-09-01\\\",\\n        \\\"adds\\\": \\\"0\\\",\\n        \\\"cancels\\\": \\\"0\\\",\\n        \\\"total\\\": \\\"7\\\",\\n        \\\"setup\\\": \\\"6\\\",\\n        \\\"trial\\\": \\\"0\\\",\\n        \\\"active\\\": \\\"1\\\",\\n        \\\"disabled\\\": \\\"0\\\",\\n        \\\"expired\\\": \\\"0\\\",\\n        \\\"grace\\\": \\\"0\\\",\\n        \\\"arrears\\\": \\\"0\\\"\\n      }\\n    ]\\n  }\\n}\",\n      \"language\": \"json\",\n      \"name\": \"https://app.klipfolio.com/api/1.0/usage-overview/monthly-client-aggregate?start_date=1472739034&end_date=1475244634\"\n    }\n  ]\n}\n[/block]\n##Response Fields\n`calendar_date`: The date.\n`adds`: Number of clients added.\n`cancels`: Number of clients removed.\n`total`: Total number of clients.\n`setup`: Total number of clients in Setup.\n`trial`: Total number of clients in Trial.\n`active`: Total number of clients Active.\n`disabled`: Total number of clients Disabled. \n`expired`: Total number of clients Expired.\n`grace`: Total number of clients in Grace.\n`arrears`: Total number of clients in Arrears.\n[block:api-header]\n{\n  \"type\": \"get\",\n  \"title\": \"GET/usage-overview/account-sign-in-trend\"\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Available for plans: Grow and above\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"Description\",\n    \"1-0\": \"Resource URL\",\n    \"4-0\": \"Response Codes\",\n    \"1-1\": \"`https://app.klipfolio.com/api/1.0/usage-overview/account-sign-in-trend`\",\n    \"0-1\": \"A trend of account sign-in activity over a period of time.\",\n    \"4-1\": \"**200**—Success\\n**400**—Bad request (missing parameter)\\n**403**—Forbidden (missing permissions)\\n**404**—Not found\",\n    \"2-0\": \"Required Permissions\",\n    \"2-1\": \"account.api\",\n    \"3-1\": \"start_date (Unix time)\\nend_date (Unix time)\",\n    \"3-0\": \"Required Parameters\"\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</tbody>\\n</table>\\n<p>Note: If company_id is not provided, the request will default to the id of the requesting user.</p>\"\n}\n[/block]\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    \\\"overview\\\": [\\n      {\\n        \\\"calendar_date\\\": \\\"2016-09-01\\\",\\n        \\\"last_login_calendar_date\\\": \\\"2016-08-01\\\",\\n        \\\"days_since_login\\\": \\\"161\\\",\\n        \\\"no_of_seats\\\": \\\"12\\\",\\n        \\\"no_of_users\\\": \\\"4\\\",\\n        \\\"24h_login_percentage\\\": \\\"0\\\",\\n        \\\"7d_login_percentage\\\": \\\"0\\\",\\n        \\\"14d_login_percentage\\\": \\\"0\\\",\\n        \\\"30d_login_percentage\\\": \\\"0\\\",\\n        \\\"90d_login_percentage\\\": \\\"50\\\"\\n      },\\n      {\\n        \\\"calendar_date\\\": \\\"2016-09-02\\\",\\n        \\\"last_login_calendar_date\\\": \\\"2016-08-01\\\",\\n        \\\"days_since_login\\\": \\\"161\\\",\\n        \\\"no_of_seats\\\": \\\"12\\\",\\n        \\\"no_of_users\\\": \\\"5\\\",\\n        \\\"24h_login_percentage\\\": \\\"20\\\",\\n        \\\"7d_login_percentage\\\": \\\"20\\\",\\n        \\\"14d_login_percentage\\\": \\\"20\\\",\\n        \\\"30d_login_percentage\\\": \\\"20\\\",\\n        \\\"90d_login_percentage\\\": \\\"60\\\"\\n      }\\n    ]\\n  }\\n}\",\n      \"language\": \"json\",\n      \"name\": \"https://app.klipfolio.com/api/1.0/usage-overview/account-sign-in-trend?start_date=1472739034&end_date=1472844007\"\n    }\n  ]\n}\n[/block]\n##Response Fields\n`calendar_date`: The date.\n`last_login_calendar_date`: Date last logged in.\n`days_since_login`: Number of days since the date last logged in and now.\n`no_of_seats`: Number of seats assigned to the company.\n`no_of_users`: Number of users existing in the company.\n`24h_login_percentage`: Percentage of users that logged in during past 24 hours.\n`7d_login_percentage`: Percentage of users that logged in during past 7 days.\n`14d_login_percentage`: Percentage of users that logged in during past 14 days.\n`30d_login_percentage`: Percentage of users that logged in during past 30 days.\n`90d_login_percentage`: Percentage of users that logged in during past 90 days.\n[block:api-header]\n{\n  \"type\": \"get\",\n  \"title\": \"GET/usage-overview/user-sign-in-trend\"\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Available for plans: Grow and above\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"Description\",\n    \"1-0\": \"Resource URL\",\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    \"1-1\": \"`https://app.klipfolio.com/api/1.0/usage-overview/user-sign-in-trend`\",\n    \"0-1\": \"A trend of user sign-in activity per day.\",\n    \"2-0\": \"Required Permissions\",\n    \"3-0\": \"Required Parameters\",\n    \"2-1\": \"account.api\",\n    \"3-1\": \"start_date (Unix time)\\nend_date (Unix time)\"\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\\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%\\\">user_id (string)</td>\\n\\t<td width=\\\"50%\\\">user.manage</td>\\n</tr>\\n</tbody>\\n</table>\\n<p>Note: If company_id is not provided, the request will default to the id of the requesting user.</p>\"\n}\n[/block]\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    \\\"overview\\\": [\\n      {\\n        \\\"CompanyName\\\": \\\"Acme\\\",\\n        \\\"FirstName\\\": \\\"Fatimah\\\",\\n        \\\"LastName\\\": \\\"Virjee\\\",\\n        \\\"Email\\\": \\\"fvirjee@acme.com\\\",\\n        \\\"AppContactId\\\": \\\"1f1234f56f123456b1234f123456a12b\\\",\\n        \\\"CalendarDate\\\": \\\"2017-04-03\\\",\\n        \\\"HMS\\\": \\\"10:18:50\\\",\\n        \\\"MobileLogin\\\": \\\"No\\\"\\n      },\\n      {\\n        \\\"CompanyName\\\": \\\"Acme\\\",\\n        \\\"FirstName\\\": \\\"Fatimah\\\",\\n        \\\"LastName\\\": \\\"Virjee\\\",\\n        \\\"Email\\\": \\\"fvirjee@acme.com\\\",\\n        \\\"AppContactId\\\": \\\"1f1234f56f123456b1234f123456a12b\\\",\\n        \\\"CalendarDate\\\": \\\"2017-04-04\\\",\\n        \\\"HMS\\\": \\\"9:44:58\\\",\\n        \\\"MobileLogin\\\": \\\"No\\\"\\n      }\\n    ]\\n  }\\n}\",\n      \"language\": \"json\",\n      \"name\": \"https://app.klipfolio.com/api/1.0/usage-overview/user-sign-in-trend?start_date=1491091200&end_date=1491264000\"\n    }\n  ]\n}\n[/block]\n#Response Fields\n`CompanyName`: Company/account name.\n`FirstName`: First name of user.\n`LastName`: Last name of user.\n`Email`: User's email address.\n`AppContactId`: User's ID.\n`CalendarDate`: The date.\n`HMS`: The time in h: m :s.\n`MobileLogin`: Yes or no response indicating whether the user signed in from a mobile device.","excerpt":"Access an overview of information on client trends, usage and growth.","slug":"app-stats","type":"basic","title":"Beta: Usage Overview"}

Beta: Usage Overview

Access an overview of information on client trends, usage and growth.

[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] [block:callout] { "type": "info", "title": "Some Application Usage Statistics are available based on your plan", "body": "Some Usage Overview endpoints are only available to users on plans: **Grow** and above." } [/block] [block:parameters] { "data": { "h-0": "Data", "h-1": "Plan", "0-0": "Daily client trend", "1-0": "Monthly client aggregate", "2-0": "Account sign-in trend", "3-0": "User sign-in trend", "0-1": "Grow and above", "1-1": "Grow and above", "2-1": "Grow and above", "3-1": "Grow and above" }, "cols": 2, "rows": 4 } [/block] [Check out (Beta) Usage Details for more Application Usage Statistics. ](http://apidocs.klipfolio.com/v1.0/docs/usage-details) [block:api-header] { "type": "get", "title": "GET /usage-overview/account-stats" } [/block] [block:parameters] { "data": { "0-0": "Description", "0-1": "A report of client activity and growth over time.", "1-0": "Resource URL", "2-0": "Required permissions", "1-1": "`https://app.klipfolio.com/api/1.0/usage-overview/account-stats`", "2-1": "account.api", "3-0": "Required parameters", "3-1": "start_date (Unix time)\nend_date (Unix time)", "4-1": "**200**—Success\n**400**—Bad request (missing parameter)\n**403**—Forbidden (missing permissions)\n**404**—Not found", "4-0": "Response codes" }, "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</tbody>\n</table>\n<p>Note: If company_id is not provided, the request will default to the id of the requesting user.</p>" } [/block] ##Example Request and Response [block:code] { "codes": [ { "code": "{\n \"meta\": {\n \"success\": true,\n \"status\": 200\n },\n \"data\": {\n \"overview\": [\n {\n \"calendar_date\": \"2016-09-27\",\n \"last_login_calendar_date\": \"2016-09-23\",\n \"no_of_seats\": \"3\",\n \"no_of_users\": \"2\",\n \"no_of_klips\": \"18\",\n \"no_of_data_sources\": \"19\",\n \"no_of_scheduled_emails\": \"4\",\n \"no_of_dashboards\": \"5\",\n \"no_of_klip_templates\": \"5\",\n \"no_of_embeds\": \"4\",\n \"data_storage_size\": \"2991\"\n },\n {\n \"calendar_date\": \"2016-09-28\",\n \"last_login_calendar_date\": \"2016-09-23\",\n \"no_of_seats\": \"3\",\n \"no_of_users\": \"2\",\n \"no_of_klips\": \"18\",\n \"no_of_data_sources\": \"19\",\n \"no_of_scheduled_emails\": \"4\",\n \"no_of_dashboards\": \"5\",\n \"no_of_klip_templates\": \"5\",\n \"no_of_embeds\": \"4\",\n \"data_storage_size\": \"2885\"\n }\n ]\n }\n}", "language": "json", "name": "https://app.klipfolio.com/api/1/usage-overview/account-stats?start_date=1474991873&end_date=1475078273" } ] } [/block] ##Response Fields `last_login_calendar_date`: The date the account was last logged into. `calendar_date`: The date. `no_of_seats`: Number of seats assigned to the company. `no_of_users`: Number of users existing in the company. `no_of_klips`: Number of Klips existing in the company. `no_of_data_sources`: Number of data sources existing in the company. `no_of_scheduled_emails`: Number of scheduled emails existing in the company. `no_of_dashboards`: Number of dashboards existing in the company. `no_of_klip_templates`: Number of Klip templates being used by the company. `no_of_embeds`: Number of embeds existing in the company. `data_storage_size`: Total data storage size (in bytes). [block:api-header] { "type": "get", "title": "GET /usage-overview/data-source-stats" } [/block] [block:parameters] { "data": { "0-0": "Description", "0-1": "The number of data sources and dynamic data source instances by service and account.", "1-0": "Resource URL", "1-1": "`https://app.klipfolio.com/api/1.0/usage-overview/data-source-stats`", "2-0": "Required permissions", "2-1": "account.api", "5-0": "Returned response fields", "6-0": "", "5-1": "", "6-1": "", "4-1": "**200**—Success\n**400**—Bad request (missing parameter)\n**403**—Forbidden (missing permissions)\n**404**—Not found", "4-0": "Response codes", "3-0": "Required parameters", "3-1": "start_date (Unix time)\nend_date (Unix time)" }, "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</tbody>\n</table>\n<p>Note: If company_id is not provided, the request will default to the id of the requesting user.</p>" } [/block] ##Example Request and Response [block:code] { "codes": [ { "code": "{\n \"meta\": {\n \"success\": true,\n \"status\": 200\n },\n \"data\": {\n \"overview\": [\n \t{\n \"company_name\": \"Acme\",\n \"calendar_date\": \"2017-04-01\",\n \"service_name\": \"Google Analytics\",\n \"connector_name\": \"Website Performance\",\n \"type_name\": \"google_analytics\",\n \"no_of_datasources\": \"6\",\n \"no_of_instances\": \"8\"\n },\n {\n \"company_name\": \"Acme\",\n \"calendar_date\": \"2017-04-01\",\n \"service_name\": \"Google Search Console\",\n \"connector_name\": \"Sites\",\n \"type_name\": \"simple_rest\",\n \"no_of_datasources\": \"2\",\n \"no_of_instances\": \"5\"\n },\n {\n \"company_name\": \"Acme\",\n \"calendar_date\": \"2017-04-02\",\n \"service_name\": \"Google Analytics\",\n \"connector_name\": \"Website Performance\",\n \"type_name\": \"google_analytics\",\n \"no_of_datasources\": \"6\",\n \"no_of_instances\": \"8\"\n },\n {\n \"company_name\": \"Acme\",\n \"calendar_date\": \"2017-04-02\",\n \"service_name\": \"Not Available\",\n \"connector_name\": \"Not Available\",\n \"type_name\": \"google_adwords\",\n \"no_of_datasources\": \"1\",\n \"no_of_instances\": \"1\"\n }\n ]\n }\n}", "language": "json", "name": "https://app.klipfolio.com/api/1.0/usage-overview/data-source-stats?start_date=1491004800&end_date=1491091200" } ] } [/block] ##Response Fields `company_name`: The company name. `calendar_date`: The date. `service_name`: Service of this data source. `connector_name`: Connector service name. `type_name`: Type name. `no_of_datasources`: Count of datasources for this service/connector/type. `no_of_instances`: Count of datasource instances for this service/connector/type. **Note**: If `service_name` or `connector_name` returns as **Not Available**, it is referring to a service that is not in the Connector Gallery. [block:api-header] { "type": "get", "title": "GET/usage-overview/api-usage" } [/block] [block:parameters] { "data": { "0-0": "Description", "1-0": "Resource URL", "1-1": "`https://app.klipfolio.com/api/1.0/usage-overview/api-usage`", "0-1": "A report of API calls and limits reached per day.", "4-0": "Response codes", "4-1": "**200**—Success\n**400**—Bad request (missing parameter)\n**403**—Forbidden (missing permissions)\n**404**—Not found", "2-0": "Required Permissions", "3-0": "Required Parameters", "2-1": "account.api", "3-1": "start_date (Unix time)\nend_date (Unix time)" }, "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</tbody>\n</table>\n<p>Note: If company_id is not provided, the request will default to the id of the requesting user.</p>" } [/block] ##Example Request and Response [block:code] { "codes": [ { "code": "{\n \"meta\": {\n \"success\": true,\n \"status\": 200\n },\n \"data\": {\n \"overview\": [\n {\n \"calendar_date\": \"2016-09-01\",\n \"api_usage\": \"24\",\n \"api_limit\": \"1000\"\n },\n {\n \"calendar_date\": \"2016-09-02\",\n \"api_usage\": \"12\",\n \"api_limit\": \"1000\"\n },\n {\n \"calendar_date\": \"2016-09-03\",\n \"api_usage\": \"6\",\n \"api_limit\": \"1000\"\n }\n ]\n }\n}", "language": "json", "name": "https://app.klipfolio.com/api/1.0/usage-overview/api-usage?start_date=1472739034&end_date=1472930407" } ] } [/block] ##Response Fields `calendar_date`: The date. `api_usage`: API calls consumed that day. `api_limit`: Company limit that day. [block:api-header] { "type": "get", "title": "GET/usage-overview/published-links" } [/block] [block:parameters] { "data": { "4-1": "**200**—Success\n**400**—Bad request (missing parameter)\n**403**—Forbidden (missing permissions)\n**404**—Not found", "3-1": "start_date (Unix time)\nend_date (Unix time)", "2-1": "account.api", "1-1": "`https://app.klipfolio.com/api/1.0/usage-overview/published-links`", "0-1": "A count on how many views a published link has per hour.", "0-0": "Description", "1-0": "Resource URL", "2-0": "Required Permissions", "3-0": "Required Parameters", "4-0": "Response Codes" }, "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</tbody>\n</table>\n<p>Note: If company_id is not provided, the request will default to the id of the requesting user.</p>" } [/block] ##Example Request and Response [block:code] { "codes": [ { "code": "{\n \"meta\": {\n \"success\": true,\n \"status\": 200\n },\n \"data\": {\n \"overview\": [{\n \"calendar_date\": \"2016-09-01\",\n \"time\": \"1:0:0\",\n \"name\": \"Marketing\",\n \"is_public\": \"No\",\n \"is_disabled\": \"No\",\n \"has_password\": \"No\",\n \"view_count\": \"29\"\n },\n {\n \"calendar_date\": \"2016-09-01\",\n \"time\": \"1:0:0\",\n \"name\": \"Sales\",\n \"is_public\": \"No\",\n \"is_disabled\": \"No\",\n \"has_password\": \"No\",\n \"view_count\": \"33\"\n },\n {\n \"calendar_date\": \"2016-09-01\",\n \"time\": \"1:0:0\",\n \"name\": \"Social Media\",\n \"is_public\": \"No\",\n \"is_disabled\": \"No\",\n \"has_password\": \"No\",\n \"view_count\": \"17\"\n },\n {", "language": "json", "name": "https://app.klipfolio.com/api/1.0/usage-overview/published-links?start_date=1472739034&end_date=1472774400" } ] } [/block] #Response Fields `calendar_date`: The date. `time`: The time in h: m :s. `name`: dashboard name `is_public`: Yes or no response indicating whether the link is public. `is_disabled`: Yes or no response indicating whether the link is disabled. `has_password`: Yes or no response indicating whether the link has a password. `view_count`: Number of views that hour. [block:api-header] { "title": "GET/usage-overview/daily-client-trend" } [/block] [block:callout] { "type": "info", "title": "Available for plans: Grow and above" } [/block] [block:parameters] { "data": { "0-0": "Description", "1-0": "Resource URL", "4-0": "Response Codes", "1-1": "`https://app.klipfolio.com/api/1.0/usage-overview/daily-client-trend`", "0-1": "A report of client additions and cancellations per day.", "4-1": "**200**—Success\n**400**—Bad request (missing parameter)\n**403**—Forbidden (missing permissions)\n**404**—Not found", "2-0": "Required Permissions", "3-0": "Required Parameters", "2-1": "account.api", "3-1": "start_date (Unix time)\nend_date (Unix time)" }, "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</tbody>\n</table>\n<p>Note: If company_id is not provided, the request will default to the id of the requesting user.</p>" } [/block] ##Example Request and Response [block:code] { "codes": [ { "code": "{\n \"meta\": {\n \"success\": true,\n \"status\": 200\n },\n \"data\": {\n \"overview\": [\n {\n \"calendar_date\": \"2016-09-01\",\n \"added\": \"1\",\n \"cancelled\":\"0\"\n }\n {\n \"calendar_date\": \"2016-09-02\",\n \"added\": \"1\",\n \"cancelled\":\"1\"\n }\n ] \n }\n\t} ", "language": "json", "name": "https://app.klipfolio.com/api/1.0/usage-overview/daily-client-trend?start_date=1472739034&end_date=1472832859" } ] } [/block] ##Response Fields `calendar_date`: The date. `added`: Number of clients added that day. `cancelled`: Number of clients removed that day. [block:api-header] { "type": "get", "title": "GET/usage-overview/monthly-client-aggregate" } [/block] [block:callout] { "type": "info", "title": "Available for plans: Grow and above" } [/block] [block:parameters] { "data": { "0-0": "Description", "1-0": "Resource URL", "4-0": "Response Codes", "1-1": "`https://app.klipfolio.com/api/1.0/usage-overview/monthly-client-aggregate`", "4-1": "**200**—Success\n**400**—Bad request (missing parameter)\n**403**—Forbidden (missing permissions)\n**404**—Not found", "0-1": "A monthly overview of client trends and activity.", "2-0": "Required Permissions", "3-0": "Required Parameters", "2-1": "account.api", "3-1": "start_date (Unix time)\nend_date (Unix time)" }, "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</tbody>\n</table>\n<p>Note: If company_id is not provided, the request will default to the id of the requesting user.</p>" } [/block] ##Example Request and Response [block:code] { "codes": [ { "code": "{\n \"meta\": {\n \"success\": true,\n \"status\": 200\n },\n \"data\": {\n \"overview\": [\n {\n \"calendar_date\": \"2016-09-01\",\n \"adds\": \"0\",\n \"cancels\": \"0\",\n \"total\": \"7\",\n \"setup\": \"6\",\n \"trial\": \"0\",\n \"active\": \"1\",\n \"disabled\": \"0\",\n \"expired\": \"0\",\n \"grace\": \"0\",\n \"arrears\": \"0\"\n }\n ]\n }\n}", "language": "json", "name": "https://app.klipfolio.com/api/1.0/usage-overview/monthly-client-aggregate?start_date=1472739034&end_date=1475244634" } ] } [/block] ##Response Fields `calendar_date`: The date. `adds`: Number of clients added. `cancels`: Number of clients removed. `total`: Total number of clients. `setup`: Total number of clients in Setup. `trial`: Total number of clients in Trial. `active`: Total number of clients Active. `disabled`: Total number of clients Disabled. `expired`: Total number of clients Expired. `grace`: Total number of clients in Grace. `arrears`: Total number of clients in Arrears. [block:api-header] { "type": "get", "title": "GET/usage-overview/account-sign-in-trend" } [/block] [block:callout] { "type": "info", "title": "Available for plans: Grow and above" } [/block] [block:parameters] { "data": { "0-0": "Description", "1-0": "Resource URL", "4-0": "Response Codes", "1-1": "`https://app.klipfolio.com/api/1.0/usage-overview/account-sign-in-trend`", "0-1": "A trend of account sign-in activity over a period of time.", "4-1": "**200**—Success\n**400**—Bad request (missing parameter)\n**403**—Forbidden (missing permissions)\n**404**—Not found", "2-0": "Required Permissions", "2-1": "account.api", "3-1": "start_date (Unix time)\nend_date (Unix time)", "3-0": "Required Parameters" }, "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</tbody>\n</table>\n<p>Note: If company_id is not provided, the request will default to the id of the requesting user.</p>" } [/block] ##Example Request and Response [block:code] { "codes": [ { "code": "{\n \"meta\": {\n \"success\": true,\n \"status\": 200\n },\n \"data\": {\n \"overview\": [\n {\n \"calendar_date\": \"2016-09-01\",\n \"last_login_calendar_date\": \"2016-08-01\",\n \"days_since_login\": \"161\",\n \"no_of_seats\": \"12\",\n \"no_of_users\": \"4\",\n \"24h_login_percentage\": \"0\",\n \"7d_login_percentage\": \"0\",\n \"14d_login_percentage\": \"0\",\n \"30d_login_percentage\": \"0\",\n \"90d_login_percentage\": \"50\"\n },\n {\n \"calendar_date\": \"2016-09-02\",\n \"last_login_calendar_date\": \"2016-08-01\",\n \"days_since_login\": \"161\",\n \"no_of_seats\": \"12\",\n \"no_of_users\": \"5\",\n \"24h_login_percentage\": \"20\",\n \"7d_login_percentage\": \"20\",\n \"14d_login_percentage\": \"20\",\n \"30d_login_percentage\": \"20\",\n \"90d_login_percentage\": \"60\"\n }\n ]\n }\n}", "language": "json", "name": "https://app.klipfolio.com/api/1.0/usage-overview/account-sign-in-trend?start_date=1472739034&end_date=1472844007" } ] } [/block] ##Response Fields `calendar_date`: The date. `last_login_calendar_date`: Date last logged in. `days_since_login`: Number of days since the date last logged in and now. `no_of_seats`: Number of seats assigned to the company. `no_of_users`: Number of users existing in the company. `24h_login_percentage`: Percentage of users that logged in during past 24 hours. `7d_login_percentage`: Percentage of users that logged in during past 7 days. `14d_login_percentage`: Percentage of users that logged in during past 14 days. `30d_login_percentage`: Percentage of users that logged in during past 30 days. `90d_login_percentage`: Percentage of users that logged in during past 90 days. [block:api-header] { "type": "get", "title": "GET/usage-overview/user-sign-in-trend" } [/block] [block:callout] { "type": "info", "title": "Available for plans: Grow and above" } [/block] [block:parameters] { "data": { "0-0": "Description", "1-0": "Resource URL", "4-0": "Response Codes", "4-1": "**200**—Success\n**400**—Bad request (missing parameter)\n**403**—Forbidden (missing permissions)\n**404**—Not found", "1-1": "`https://app.klipfolio.com/api/1.0/usage-overview/user-sign-in-trend`", "0-1": "A trend of user sign-in activity per day.", "2-0": "Required Permissions", "3-0": "Required Parameters", "2-1": "account.api", "3-1": "start_date (Unix time)\nend_date (Unix time)" }, "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\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%\">user_id (string)</td>\n\t<td width=\"50%\">user.manage</td>\n</tr>\n</tbody>\n</table>\n<p>Note: If company_id is not provided, the request will default to the id of the requesting user.</p>" } [/block] ##Example Request and Response [block:code] { "codes": [ { "code": "{\n \"meta\": {\n \"success\": true,\n \"status\": 200\n },\n \"data\": {\n \"overview\": [\n {\n \"CompanyName\": \"Acme\",\n \"FirstName\": \"Fatimah\",\n \"LastName\": \"Virjee\",\n \"Email\": \"fvirjee@acme.com\",\n \"AppContactId\": \"1f1234f56f123456b1234f123456a12b\",\n \"CalendarDate\": \"2017-04-03\",\n \"HMS\": \"10:18:50\",\n \"MobileLogin\": \"No\"\n },\n {\n \"CompanyName\": \"Acme\",\n \"FirstName\": \"Fatimah\",\n \"LastName\": \"Virjee\",\n \"Email\": \"fvirjee@acme.com\",\n \"AppContactId\": \"1f1234f56f123456b1234f123456a12b\",\n \"CalendarDate\": \"2017-04-04\",\n \"HMS\": \"9:44:58\",\n \"MobileLogin\": \"No\"\n }\n ]\n }\n}", "language": "json", "name": "https://app.klipfolio.com/api/1.0/usage-overview/user-sign-in-trend?start_date=1491091200&end_date=1491264000" } ] } [/block] #Response Fields `CompanyName`: Company/account name. `FirstName`: First name of user. `LastName`: Last name of user. `Email`: User's email address. `AppContactId`: User's ID. `CalendarDate`: The date. `HMS`: The time in h: m :s. `MobileLogin`: Yes or no response indicating whether the user signed in from a mobile device.