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

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

Examples

from Opik import OpikApi client = OpikApi(api_key=”YOUR_API_KEY”, workspace_name=”YOUR_WORKSPACE_NAME”, ) client.system_usage.get_dataset_bi_info()

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

Examples

from Opik import OpikApi client = OpikApi(api_key=”YOUR_API_KEY”, workspace_name=”YOUR_WORKSPACE_NAME”, ) client.system_usage.get_experiment_bi_info()

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

Examples

from Opik import OpikApi client = OpikApi(api_key=”YOUR_API_KEY”, workspace_name=”YOUR_WORKSPACE_NAME”, ) client.system_usage.get_spans_bi_info()

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

Examples

from Opik import OpikApi client = OpikApi(api_key=”YOUR_API_KEY”, workspace_name=”YOUR_WORKSPACE_NAME”, ) client.system_usage.get_spans_count_for_workspaces()

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

Examples

from Opik import OpikApi client = OpikApi(api_key=”YOUR_API_KEY”, workspace_name=”YOUR_WORKSPACE_NAME”, ) client.system_usage.get_traces_bi_info()

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

Examples

from Opik import OpikApi client = OpikApi(api_key=”YOUR_API_KEY”, workspace_name=”YOUR_WORKSPACE_NAME”, ) client.system_usage.get_traces_count_for_workspaces()

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