Skip to main content

kobana dashboards usage

Get platform usage

Commands of kobana dashboards usage. Every global option (Global options) applies here.

CommandHTTPDescription
usageGET /v1/usageGet platform usage

usage​

Get platform usage

kobana dashboards usage [OPTIONS]

GET /v1/usage

For each metric (members, customers, portal users, integrations…), the daily series in the range, the latest value and the peak. Default: current month; at most 12 months back. Organization-level.

Query parameters

NameTypeRequiredDescription
start_datestringnoFirst day (YYYY-MM-DD). Default: day 1 of the current month.
end_datestringnoLast day (YYYY-MM-DD). Default: today.

Headers

NameTypeRequiredDescription
X-Workspace-IdstringnoWorkspace the call acts on: the id or the public_id shown under Workspaces on the dashboard. Inside the token's organization, data lives in workspaces. It may be omitted while the organization has a single workspace; with two or more, leaving it out returns 400 workspace_required. A workspace outside the organization returns 403 unknown_workspace. With a person token, only the workspaces that person has access to are reachable (organization owners reach all of them); any other returns 403 workspace_access_denied.

Responses

HTTPDescription
200The usage.
404Resource not found in the current organization.