Skip to main content

kobana kadu usage

Usage and cost of executions, conversations and memory consolidation

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

CommandHTTPDescription
usageGET /v1/usageUsage and cost of executions, conversations and memory consolidation
usage performanceGET /v1/usage/performancePerformance: duration, success and failure, memory, files and volumes

usage​

Usage and cost of executions, conversations and memory consolidation

kobana kadu usage [OPTIONS] [COMMAND]

GET /v1/usage

Aggregated per day (in the organization's time zone) × group, adding up executions, Slack bot conversation turns (source slack_chat, no workspace/activity/Task) and memory consolidation (source memory_consolidation, in the workspace/activity/Task of the originating execution). by_kind separates the three: what is conversation and what is not. Default: last 30 days; maximum range of 366 days. group is the id (tier, workspace, activity, task) or the source; null = no value.

Query parameters

NameTypeRequiredDescription
fromstringno
tostringno
group_bystringnoValues: tier, workspace, activity, task, source.
workspace_idstringno
activity_idstringno
task_idstringno
sourcestringno

Responses

HTTPDescription
200OK
400VALIDATION_ERROR
503AS_UNAVAILABLE — token verification is unavailable (Authorization Server down or configuration missing). Try again (Retry-After).

usage performance​

Performance: duration, success and failure, memory, files and volumes

kobana kadu usage performance [OPTIONS]

GET /v1/usage/performance

Daily series (in the organization's time zone) with the average execution duration (total, bootstrap and effective run), finished executions by result, the memories existing at the end of the day (count and bytes of content + summary), the accumulated size of input and output files, filterable by extension (file_type), and that of the volumes (volume_id). Default: last 30 days; maximum range of 366 days. Memories have no task or source: only workspace and activity filter the memory. Requires Analytics › Performance to be enabled.

Query parameters

NameTypeRequiredDescription
fromstringno
tostringno
workspace_idstringno
activity_idstringno
task_idstringno
sourcestringno
file_typestringnoExtension of the files in the files chart (e.g. pdf); __none__ = no extension. Omitted = all.
volume_idstringnoOnly this volume in the volume series. An id outside the organization's volumes = all.

Responses

HTTPDescription
200OK
400VALIDATION_ERROR
503AS_UNAVAILABLE — token verification is unavailable (Authorization Server down or configuration missing). Try again (Retry-After).