Guides

Beta: Usage Details

Access information on account trends and usage.

🚧

Application Usage Statistics are currently a beta release

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

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

GET /usage-details/published-link-views

DescriptionTrack every published link view.
Resource URLhttps://app.klipfolio.com/api/1.0/usage-details/published-link-views
Required permissionsaccount.api
Required parametersstart_date (Unix time)
end_date (Unix time)
agg_method: count, distinct, integral, mean, median, spread, sum
interval (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.
Response codes200—Success
400—Bad request (missing parameter)
403—Forbidden (missing permissions)
404—Not found
Optional parameters Permissions
company_id (string) client.access
unit
s (seconds)
m (minutes)
h (hours)
d (days)
w (weeks)		 no permission
link_id (string) tab.publish
is_public no permission

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

{
  "meta": {
    "success": true,
    "status": 200
  },
  "data": {
    "measurement": "published-link-views",
    "agg_method": "SUM",
    "interval": 5,
    "unit": "m",
    "results": [
      {
        "timestamp": "2016-09-16T00:00:00Z",
        "value": 249
      },
      {
        "timestamp": "2016-09-21T00:00:00Z",
        "value": 171
      }
    ]
  }
}

GET /usage-details/api-calls

DescriptionTrack every API call.
Resource URLPermissionshttps://app.klipfolio.com/api/1.0/usage-details/api-calls
Required permissionsaccount.api
Required parametersstart_date (Unix time)
end_date (Unix time)
agg_method: count, distinct, integral, mean, median, spread, sum
interval (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.
Response codes200—Success
400—Bad request (missing parameter)
403—Forbidden (missing permissions)
404—Not found
Optional parameters Permissions
company_id (string) client.access
unit
s (seconds)
m (minutes)
h (hours)
d (days)
w (weeks)		 no permission

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

{
  "meta": {
    "success": true,
    "status": 200
  },
  "data": {
    "measurement": "api-calls",
    "agg_method": "SUM",
    "interval": 5,
    "unit": "m",
    "results": [
      {
        "timestamp": "2016-09-16T00:00:00Z",
        "value": 923
      },
      {
        "timestamp": "2016-09-21T00:00:00Z",
        "value": 871
      }
    ]
  }
}

GET /usage-details/api-calls-over-limit

DescriptionTrack the number of API calls over the limit.
Resource URLhttps://app.klipfolio.com/api/1.0/usage-details/api-calls-over-limits
Required permissionsaccount.api
Required parametersstart_date (Unix time)
end_date (Unix time)
agg_method: count, distinct, integral, mean, median, spread, sum
interval (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.
Response codes200—Success
400—Bad request (missing parameter)
403—Forbidden (missing permissions)
404—Not found
Optional parameters Permissions
company_id (string) client.access
unit
s (seconds)
m (minutes)
h (hours)
d (days)
w (weeks)		 no permission

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

{
  "meta": {
    "success": true,
    "status": 200
  },
  "data": {
    "measurement": "api-calls-over-limit",
    "agg_method": "SUM",
    "interval": 5,
    "unit": "m",
    "results": [
      {
        "timestamp": "2016-09-16T00:00:00Z",
        "value": 12
      },
      {
        "timestamp": "2016-09-21T00:00:00Z",
        "value": 23
      }
    ]
  }
}

GET/usage-details/dashboard-views

DescriptionTrack dashboard views by user.
Resource URLhttps://app.klipfolio.com/api/1.0/usage-details/dashboard-views
Required permissionsaccount.api
Required parametersstart_date (Unix time)
end_date (Unix time)
agg_method: count, distinct, integral, mean, median, spread, sum
interval (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.
Response Codes200—Success
400—Bad request (missing parameter)
403—Forbidden (missing permissions)
404—Not found
Optional parameters Permissions
company_id (string) client.access
unit
s (seconds)
m (minutes)
h (hours)
d (days)
w (weeks)		 no permission
user_id
dashboard_id

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

{
  "meta": {
    "success": true,
    "status": 200
  },
  "data": {
    "measurement": "dashboard-views",
    "agg_method": "SUM",
    "interval": 5,
    "unit": "m",
    "results": [
      {
        "timestamp": "2016-09-16T00:00:00Z",
        "value": 149
      },
      {
        "timestamp": "2016-09-21T00:00:00Z",
        "value": 271
      }
    ]
  }
}