Get Metrics By Date Range

GET 
/api/v2/org/:org_id/workspace/:workspace_id/metrics

Get workspace metrics by date range using cursor pagination in descending order.

Retrieves metrics based on their created_at timestamp (not the event time field). Results are ordered by created_at DESC, id DESC for consistent cursor pagination.

Args:

org_id (str): Path parameter - Organization ID that owns the workspace workspace_id (str): Path parameter - Target workspace ID to query metrics from from_date (datetime): Query parameter - Start date for filtering (inclusive) to_date (datetime): Query parameter - End date for filtering (inclusive) metric_types (list[str], optional): Query parameter - Filter by specific metric types Examples: ["auth.user.login", "chat.message.create"] If None, returns all metric types size (int): Query parameter - Maximum records to return (default: 100, max: 1000) cursor (str, optional): Query parameter - Cursor for pagination Base64 encoded datetime string from the 'next_page' field of previous response When not provided, starts from the end (to_date) and goes backwards include_total (bool): Query parameter - Include total count of entries (default: False) When true, calculates and returns the total number of entries in the database

Returns

MetricsPaginatedResponse: Paginated response containing:

• items: List of metrics matching the criteria (newest first)
• total: Total count of metrics in the date range (only when include_total=True)
• current_page: Current cursor (if provided)
• next_page: Cursor for next page (if more results available)

Details

• Filtering is done on created_at timestamp, NOT the event time field
• Date range is inclusive on both ends
• Results are ordered by (created_at DESC, id DESC) for descending cursor pagination
• When cursor is provided, it replaces the to_date for that query (going backwards)
• Large date ranges may impact performance for total count calculation
• Timezone information in dates is preserved but comparison is done in UTC
• Cursors are base64-encoded datetime strings for security and consistency
• Returns newest metrics first (descending order by creation time)

Permissions:

• Scope: workspace_metrics:read
• Allowed Roles:
  • superadmin: ✓
  • admin: ✓
  • controller: ✓
  • curator: ✓
  • basic: ✗ (read permission denied)

Request

Responses

200

Successful Response

422

Validation Error