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