System Usage Client¶

The System Usage client provides methods for retrieving system usage metrics in the Opik platform.

class opik.rest_api.system_usage.client.SystemUsageClient(*, client_wrapper: SyncClientWrapper)¶

Bases: object

find_usage_projects(*, workspace_ids: Sequence[str], project_ids: Sequence[str] | None = OMIT, name: str | None = OMIT, limit: int | None = OMIT, request_options: RequestOptions | None = None) → UsageProjectsResponse¶

Find projects across the given workspaces, optionally narrowed by project ids or a case-insensitive name substring. Unknown or deleted projects are omitted.

Parameters:

workspace_ids (Sequence[str])
project_ids (Optional[Sequence[str]])
name (Optional[str])
limit (Optional[int])
request_options (Optional[RequestOptions]) – Request-specific configuration.

Returns:

UsageProjectsResponse resource

Return type:

UsageProjectsResponse

get_dataset_bi_info(*, request_options: RequestOptions | None = None) → BiInformationResponse¶

Get datasets information for BI events per user per workspace

Parameters:: request_options (Optional[RequestOptions]) – Request-specific configuration.
Returns:: Datasets BiInformationResponse resource
Return type:: BiInformationResponse

get_experiment_bi_info(*, request_options: RequestOptions | None = None) → BiInformationResponse¶

Get experiments information for BI events per user per workspace

Parameters:: request_options (Optional[RequestOptions]) – Request-specific configuration.
Returns:: Experiments BiInformationResponse resource
Return type:: BiInformationResponse

get_spans_bi_info(*, request_options: RequestOptions | None = None) → BiInformationResponse¶

Get spans information for BI events per user per workspace

Parameters:: request_options (Optional[RequestOptions]) – Request-specific configuration.
Returns:: Spans BiInformationResponse resource
Return type:: BiInformationResponse

get_spans_count_breakdown_for_workspaces(*, request_options: RequestOptions | None = None) → UsageByWorkspaceProjectUserResponse¶

Get spans count on previous day grouped by workspace, project and user

Parameters:: request_options (Optional[RequestOptions]) – Request-specific configuration.
Returns:: UsageByWorkspaceProjectUserResponse resource
Return type:: UsageByWorkspaceProjectUserResponse

get_spans_count_for_workspaces(*, request_options: RequestOptions | None = None) → SpansCountResponse¶

Get spans count on previous day for all available workspaces

Parameters:: request_options (Optional[RequestOptions]) – Request-specific configuration.
Returns:: SpanCountResponse resource
Return type:: SpansCountResponse

get_traces_bi_info(*, request_options: RequestOptions | None = None) → BiInformationResponse¶

Get traces information for BI events per user per workspace

Parameters:: request_options (Optional[RequestOptions]) – Request-specific configuration.
Returns:: Traces BiInformationResponse resource
Return type:: BiInformationResponse

get_traces_count_for_workspaces(*, request_options: RequestOptions | None = None) → TraceCountResponse¶

Get traces count on previous day for all available workspaces

Parameters:: request_options (Optional[RequestOptions]) – Request-specific configuration.
Returns:: TraceCountResponse resource
Return type:: TraceCountResponse

Usage Example¶

import opik

client = opik.Opik()

# Get system usage metrics
usage = client.rest_client.system_usage.get_system_usage()

# Get workspace usage summary
workspace_usage = client.rest_client.system_usage.get_workspace_usage_summary()