Workspaces Client

The Workspaces client provides methods for managing workspaces in the Opik platform.

class opik.rest_api.workspaces.client.WorkspacesClient(*, client_wrapper: SyncClientWrapper)

Bases: object

metrics_summary(*, interval_start: datetime, interval_end: datetime, project_ids: Sequence[str] | None = OMIT, request_options: RequestOptions | None = None) → WorkspaceMetricsSummaryResponse

Get metrics summary

Parameters:

  • interval_start (dt.datetime)

  • interval_end (dt.datetime)

  • project_ids (Optional[Sequence[str]])

  • request_options (Optional[RequestOptions]) – Request-specific configuration.

Returns:

Workspace Metrics

Return type:

WorkspaceMetricsSummaryResponse

Examples

from Opik import OpikApi import datetime client = OpikApi(api_key=”YOUR_API_KEY”, workspace_name=”YOUR_WORKSPACE_NAME”, ) client.workspaces.metrics_summary(interval_start=datetime.datetime.fromisoformat(“2024-01-15 09:30:00+00:00”, ), interval_end=datetime.datetime.fromisoformat(“2024-01-15 09:30:00+00:00”, ), )

Usage Example

import opik

client = opik.Opik()

# Get workspace information
workspace = client.rest_client.workspaces.get_workspace()

# Get workspace statistics
stats = client.rest_client.workspaces.get_workspace_stats()