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

🚧

Application Usage Statistics are currently a beta release

Note: Because this is a beta release, some history may not be retained.

📘

Some Application Usage Statistics are available based on your plan

The following Usage Overview endpoints are only available to users on plans Grow and above:

Daily client trend
Monthly client aggregate
Account sign-in trend
User sign-in trend

Check out (Beta) Usage Details for more Application Usage Statistics.

GET /usage-overview/account-stats

DescriptionA report of client activity and growth over time.
Resource URLhttps://app.klipfolio.com/api/1.0/usage-overview/account-stats
Required permissionsaccount.api
Required parametersstart_date (Unix time)
end_date (Unix time)
Response codes200—Success
400—Bad request (missing parameter)
403—Forbidden (missing permissions)
404—Not found
Optional parameters Permissions
company_id (string) client.access

Note: If company_id is not provided, the request will default to the id of the requesting user.

Example Request and Response

{
  "meta": {
    "success": true,
    "status": 200
  },
  "data": {
    "overview": [
      {
        "calendar_date": "2016-09-27",
        "last_login_calendar_date": "2016-09-23",
        "no_of_seats": "3",
        "no_of_users": "2",
        "no_of_klips": "18",
        "no_of_data_sources": "19",
        "no_of_scheduled_emails": "4",
        "no_of_dashboards": "5",
        "no_of_klip_templates": "5",
        "no_of_embeds": "4",
        "data_storage_size": "2991"
      },
      {
        "calendar_date": "2016-09-28",
        "last_login_calendar_date": "2016-09-23",
        "no_of_seats": "3",
        "no_of_users": "2",
        "no_of_klips": "18",
        "no_of_data_sources": "19",
        "no_of_scheduled_emails": "4",
        "no_of_dashboards": "5",
        "no_of_klip_templates": "5",
        "no_of_embeds": "4",
        "data_storage_size": "2885"
      }
    ]
  }
}

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).

GET /usage-overview/data-source-stats

DescriptionThe number of data sources and dynamic data source instances by service and account.
Resource URLhttps://app.klipfolio.com/api/1.0/usage-overview/data-source-stats
Required permissionsaccount.api
Required parametersstart_date (Unix time)
end_date (Unix time)
Response codes200—Success
400—Bad request (missing parameter)
403—Forbidden (missing permissions)
404—Not found
Optional parameters Permissions
company_id (string) client.access

Note: If company_id is not provided, the request will default to the id of the requesting user.

Example Request and Response

{
  "meta": {
    "success": true,
    "status": 200
  },
  "data": {
    "overview": [
    	{
        "company_name": "Acme",
        "calendar_date": "2017-04-01",
        "service_name": "Google Analytics",
        "connector_name": "Website Performance",
        "type_name": "google_analytics",
        "no_of_datasources": "6",
        "no_of_instances": "8"
      },
      {
        "company_name": "Acme",
        "calendar_date": "2017-04-01",
        "service_name": "Google Search Console",
        "connector_name": "Sites",
        "type_name": "simple_rest",
        "no_of_datasources": "2",
        "no_of_instances": "5"
      },
      {
        "company_name": "Acme",
        "calendar_date": "2017-04-02",
        "service_name": "Google Analytics",
        "connector_name": "Website Performance",
        "type_name": "google_analytics",
        "no_of_datasources": "6",
        "no_of_instances": "8"
      },
      {
        "company_name": "Acme",
        "calendar_date": "2017-04-02",
        "service_name": "Not Available",
        "connector_name": "Not Available",
        "type_name": "google_adwords",
        "no_of_datasources": "1",
        "no_of_instances": "1"
      }
    ]
  }
}

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.

GET/usage-overview/api-usage

DescriptionA report of API calls and limits reached per day.
Resource URLhttps://app.klipfolio.com/api/1.0/usage-overview/api-usage
Required Permissionsaccount.api
Required Parametersstart_date (Unix time)
end_date (Unix time)
Response codes200—Success
400—Bad request (missing parameter)
403—Forbidden (missing permissions)
404—Not found
Optional Parameters Permissions
company_id (string) client.access

Note: If company_id is not provided, the request will default to the id of the requesting user.

Example Request and Response

{
  "meta": {
    "success": true,
    "status": 200
  },
  "data": {
    "overview": [
      {
        "calendar_date": "2016-09-01",
        "api_usage": "24",
        "api_limit": "1000"
      },
      {
        "calendar_date": "2016-09-02",
        "api_usage": "12",
        "api_limit": "1000"
      },
      {
        "calendar_date": "2016-09-03",
        "api_usage": "6",
        "api_limit": "1000"
      }
    ]
  }
}

Response Fields

calendar_date: The date.
api_usage: API calls consumed that day.
api_limit: Company limit that day.

GET/usage-overview/published-links

DescriptionA count on how many views a published link has per hour.
Resource URLhttps://app.klipfolio.com/api/1.0/usage-overview/published-links
Required Permissionsaccount.api
Required Parametersstart_date (Unix time)
end_date (Unix time)
Response Codes200—Success
400—Bad request (missing parameter)
403—Forbidden (missing permissions)
404—Not found
Optional Parameters Permissions
company_id (string) client.access

Note: If company_id is not provided, the request will default to the id of the requesting user.

Example Request and Response

{
  "meta": {
    "success": true,
    "status": 200
  },
   "data": {
        "overview": [{
            "calendar_date": "2016-09-01",
            "time": "1:0:0",
            "name": "Marketing",
            "is_public": "No",
            "is_disabled": "No",
            "has_password": "No",
            "view_count": "29"
        },
        {
            "calendar_date": "2016-09-01",
            "time": "1:0:0",
            "name": "Sales",
            "is_public": "No",
            "is_disabled": "No",
            "has_password": "No",
            "view_count": "33"
        },
        {
            "calendar_date": "2016-09-01",
            "time": "1:0:0",
            "name": "Social Media",
            "is_public": "No",
            "is_disabled": "No",
            "has_password": "No",
            "view_count": "17"
        },
        {

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.

GET/usage-overview/daily-client-trend

📘

Available for plans: Grow and above

DescriptionA report of client additions and cancellations per day.
Resource URLhttps://app.klipfolio.com/api/1.0/usage-overview/daily-client-trend
Required Permissionsaccount.api
Required Parametersstart_date (Unix time)
end_date (Unix time)
Response Codes200—Success
400—Bad request (missing parameter)
403—Forbidden (missing permissions)
404—Not found
Optional Parameters Permissions
company_id (string) client.access

Note: If company_id is not provided, the request will default to the id of the requesting user.

Example Request and Response

{
  "meta": {
    "success": true,
    "status": 200
  },
  "data": {
    "overview": [
      {
        "calendar_date": "2016-09-01",
        "added": "1",
        "cancelled":"0"
      }
      {
       "calendar_date": "2016-09-02",
        "added": "1",
        "cancelled":"1"
      }
     ] 
    }
	}

Response Fields

calendar_date: The date.
added: Number of clients added that day.
cancelled: Number of clients removed that day.

GET/usage-overview/monthly-client-aggregate

📘

Available for plans: Grow and above

DescriptionA monthly overview of client trends and activity.
Resource URLhttps://app.klipfolio.com/api/1.0/usage-overview/monthly-client-aggregate
Required Permissionsaccount.api
Required Parametersstart_date (Unix time)
end_date (Unix time)
Response Codes200—Success
400—Bad request (missing parameter)
403—Forbidden (missing permissions)
404—Not found
Optional Parameters Permissions
company_id (string) client.access

Note: If company_id is not provided, the request will default to the id of the requesting user.

Example Request and Response

{
  "meta": {
    "success": true,
    "status": 200
  },
  "data": {
    "overview": [
      {
        "calendar_date": "2016-09-01",
        "adds": "0",
        "cancels": "0",
        "total": "7",
        "setup": "6",
        "trial": "0",
        "active": "1",
        "disabled": "0",
        "expired": "0",
        "grace": "0",
        "arrears": "0"
      }
    ]
  }
}

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.

GET/usage-overview/account-sign-in-trend

📘

Available for plans: Grow and above

DescriptionA trend of account sign-in activity over a period of time.
Resource URLhttps://app.klipfolio.com/api/1.0/usage-overview/account-sign-in-trend
Required Permissionsaccount.api
Required Parametersstart_date (Unix time)
end_date (Unix time)
Response Codes200—Success
400—Bad request (missing parameter)
403—Forbidden (missing permissions)
404—Not found
Optional Parameters Permissions
company_id (string) client.access

Note: If company_id is not provided, the request will default to the id of the requesting user.

Example Request and Response

{
  "meta": {
    "success": true,
    "status": 200
  },
  "data": {
    "overview": [
      {
        "calendar_date": "2016-09-01",
        "last_login_calendar_date": "2016-08-01",
        "days_since_login": "161",
        "no_of_seats": "12",
        "no_of_users": "4",
        "24h_login_percentage": "0",
        "7d_login_percentage": "0",
        "14d_login_percentage": "0",
        "30d_login_percentage": "0",
        "90d_login_percentage": "50"
      },
      {
        "calendar_date": "2016-09-02",
        "last_login_calendar_date": "2016-08-01",
        "days_since_login": "161",
        "no_of_seats": "12",
        "no_of_users": "5",
        "24h_login_percentage": "20",
        "7d_login_percentage": "20",
        "14d_login_percentage": "20",
        "30d_login_percentage": "20",
        "90d_login_percentage": "60"
      }
    ]
  }
}

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.

GET/usage-overview/user-sign-in-trend

📘

Available for plans: Grow and above

DescriptionA trend of user sign-in activity per day.
Resource URLhttps://app.klipfolio.com/api/1.0/usage-overview/user-sign-in-trend
Required Permissionsaccount.api
Required Parametersstart_date (Unix time)
end_date (Unix time)
Response Codes200—Success
400—Bad request (missing parameter)
403—Forbidden (missing permissions)
404—Not found
Optional Parameters Permissions
company_id (string) client.access
user_id (string) user.manage

Note: If company_id is not provided, the request will default to the id of the requesting user.

Example Request and Response

{
  "meta": {
    "success": true,
    "status": 200
  },
 "data": {
    "overview": [
      {
        "CompanyName": "Acme",
        "FirstName": "Fatimah",
        "LastName": "Virjee",
        "Email": "[email protected]",
        "AppContactId": "1f1234f56f123456b1234f123456a12b",
        "CalendarDate": "2017-04-03",
        "HMS": "10:18:50",
        "MobileLogin": "No"
      },
      {
        "CompanyName": "Acme",
        "FirstName": "Fatimah",
        "LastName": "Virjee",
        "Email": "[email protected]",
        "AppContactId": "1f1234f56f123456b1234f123456a12b",
        "CalendarDate": "2017-04-04",
        "HMS": "9:44:58",
        "MobileLogin": "No"
      }
    ]
  }
}

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.