--- title: "Get Global Dashboard Metrics" method: GET path: "/v2/tms/global-dashboard/metrics" tags: ["v2", "tms", "global-dashboard"] --- # Get Global Dashboard Metrics `GET /v2/tms/global-dashboard/metrics` ## Request - Base URL: `https://api.mentium.io` (the document declares no server; this is the origin it was published from) - URL: `https://api.mentium.io/v2/tms/global-dashboard/metrics` - Auth: HTTP bearer Get global TMS dashboard metrics for a focus timeframe with historical and projected trends. Request: GetGlobalDashboardMetricsRequest - integration_connection_id: str - current_datetime: datetime - timeframe_type: TimeframeType - interval_type: IntervalType - focus_timeframe_start_datetime: datetime - focus_timeframe_end_datetime_exclusive: datetime - historical_trend_timeframes_offset: int (≤ 0) - projected_trend_timeframes_offset: int (== 0) Response: GetGlobalDashboardMetricsResponse - timeframe_metrics: list[TimeFrameMetrics] - timeframe_type: TimeframeType - timeframe_start_datetime: datetime - timeframe_end_datetime_exclusive: datetime - elapsed_working_days: int - remaining_working_days: int - organization_metrics: OrganizationMetrics - total_loads: int - average_loads_per_interval: float - projected_total_loads: int - total_revenue: float - average_revenue_per_load: float - average_revenue_per_interval: float - projected_total_revenue: float - total_margin: float - average_margin_per_load: float - average_margin_per_interval: float - margin_percentage: float - projected_total_margin: float - sales_representative_metrics: list[SalesRepresentativeMetrics] (optional) - top_carriers_metrics: list[TopCarriersMetrics] (optional) ## Query parameters - `integration_connection_id` string, required: TMS integration connection UUID - `current_datetime` string, date-time, required: Current datetime (UTC) sourced from request for consistency - `timeframe_type` 'DAY' | 'WEEK' | 'MONTH' | 'QUARTER' | 'YEAR' | 'CUSTOM', required: Calendar time window type in which to calculate metrics E.g. average of revenue/week during a month i.e. average([week1:revenue/week, week2:revenue/week, week3:revenue/week, week4:revenue/week]) - `interval_type` 'DAY' | 'WEEK' | 'MONTH', required: Calender time unit type in which to average metrics E.g. revenue/week - `focus_timeframe_start_datetime` string, date-time, required: Start of the timeframe the user is viewing (inclusive lower bound) Example: - Viewing October 2025: 2025-10-01T00:00:00Z - Viewing custom August 12-24: 2025-08-12T00:00:00Z - `focus_timeframe_end_datetime_exclusive` string, date-time, required: End of the timeframe the user is viewing (exclusive upper bound) Example: - Viewing October 2025: 2025-11-01T00:00:00Z (November 1 start, not October 31 end) - Viewing custom August 12-24: 2025-08-25T00:00:00Z (Aug 25 start) - `historical_trend_timeframes_offset` integer, required: Number of timeframes to include in the historical trend before the focus timeframe Example: - timeframe_type = MONTH focus_timeframe_start_datetime = 2025-11-01T00:00:00Z focus_timeframe_end_datetime_exclusive = 2025-12-01T00:00:00Z -> focus_timeframe = November 2025 historical_trend_timeframes_offset = 0 # no trends before focus -> historical_trend_timeframes = [] Example: - timeframe_type = MONTH focus_timeframe_start_datetime = 2025-11-01T00:00:00Z focus_timeframe_end_datetime_exclusive = 2025-12-01T00:00:00Z -> focus_timeframe = November 2025 historical_trend_timeframes_offset = -2 # 2 months before focus -> historical_trend_timeframes = [September 2025, October 2025] - `projected_trend_timeframes_offset` integer, required: Number of timeframes to include in the projected trend after the focus timeframe Example: - timeframe_type = MONTH focus_timeframe_start_datetime = 2025-12-01T00:00:00Z focus_timeframe_end_datetime_exclusive = 2026-01-01T00:00:00Z -> focus_timeframe = December 2025 projected_trend_timeframes_offset = 0 # no trends after focus -> projected_trend_timeframes = [] Example: - timeframe_type = MONTH focus_timeframe_start_datetime = 2025-12-01T00:00:00Z focus_timeframe_end_datetime_exclusive = 2026-01-01T00:00:00Z -> focus_timeframe = December 2025 projected_trend_timeframes_offset = 3 # 3 months after focus -> projected_trend_timeframes = [January 2026, February 2026, March 2026] ## Headers - `mentium-workspace-id` string, nullable ## Response `200` Successful Response - GetGlobalDashboardMetricsResponse: Response model for global dashboard metrics - `timeframe_metrics` TimeFrameMetrics[], required: Timeframe metrics for the date range - `timeframe_type` 'DAY' | 'WEEK' | 'MONTH' | 'QUARTER' | 'YEAR' | 'CUSTOM', required: Calendar time window type in which to calculate metrics E.g. average of revenue/week during a month i.e. average([week1:revenue/week, week2:revenue/week, week3:revenue/week, week4:revenue/week]) - `timeframe_start_datetime` string, date-time, required: Start datetime (inclusive lower bound) - `timeframe_end_datetime_exclusive` string, date-time, required: End datetime (exclusive upper bound) - `elapsed_working_days` integer, required: Working days in the timeframe elapsed - `remaining_working_days` integer, required: Working days in the timeframe remaining - `organization_metrics` OrganizationMetrics, required - `total_loads` integer, required: Total loads - `average_loads_per_interval` number, nullable: Average loads per interval - `projected_total_loads` integer, nullable: Projected total loads in the timeframe - `total_revenue` number, required: Total revenue - `average_revenue_per_load` number, nullable: Average revenue per load - `average_revenue_per_interval` number, nullable: Average revenue per interval - `projected_total_revenue` number, nullable: Projected total revenue in the timeframe - `total_margin` number, required: Total margin - `average_margin_per_load` number, nullable: Average margin per load - `average_margin_per_interval` number, nullable: Average margin per interval - `margin_percentage` number, nullable: Margin percentage - `projected_total_margin` number, nullable: Projected total margin in the timeframe - `sales_representative_metrics` SalesRepresentativeMetrics[], nullable: Sales representative metrics for the date range - `name` string, required: Name of sales representative - `total_loads` integer, required: Total loads - `average_loads_per_interval` number, nullable: Average loads per interval - `loads_per_interval_goal` integer, nullable: Loads per interval goal - `assigned_loads` integer, required: Loads assigned to this sales representative - `assigned_loads_handled_by_self` integer, required: Loads where assigned_sales_representative_id == actual_sales_representative_id - `assigned_loads_handled_by_self_percentage` number, nullable: Percentage of assigned loads handled by self (assigned_loads_handled_by_self / assigned_loads) - `assigned_loads_handled_by_others` integer, required: Loads handled by other sales representatives - `assigned_loads_handled_by_others_percentage` number, nullable: Percentage of assigned loads handled by others (assigned_loads_handled_by_others / assigned_loads) - `non_assigned_loads_handled_by_self` integer, required: Loads not assigned to this sales representative - `non_assigned_loads_handled_by_self_percentage` number, nullable: Percentage of non-assigned loads handled by self (non_assigned_loads_handled_by_self / total_loads) - `total_revenue` number, required: Total revenue - `total_margin` number, required: Total margin - `margin_percentage` number, nullable: Margin percentage - `total_bids_placed` integer, nullable: Total bids placed - `average_bids_placed_per_load` number, nullable: Average bids placed per load - `average_bids_placed_per_interval` number, nullable: Average bids placed per interval - `rolled_percentage` number, nullable: Percentage of loads for which both booked_at and assigned_at are not null and (booked_at - assigned_at) is greater than 1 day - `total_carriers_booked` integer, required: Total carriers booked - `top_carriers_metrics` TopCarriersMetrics[], nullable: Top carriers metrics for the date range - `name` string, required: Name of carrier - `total_loads` integer, required: Total loads - `average_loads_per_interval` number, nullable: Average loads per interval - `total_spend` number, required: Total spend on carrier - `average_spend_per_load` number, nullable: Average spend per load - `total_margin` number, required: Total margin - `average_margin_per_load` number, nullable: Average margin per load - `margin_percentage` number, nullable: Margin percentage - `top_lanes` CarrierLane[]: Top 5 lanes for this carrier - `source_city` string, required: Source city - `source_state` string, required: Source state - `destination_city` string, required: Destination city - `destination_state` string, required: Destination state - `total_loads` integer, required: Total loads - `total_spend` number, required: Total spend on carrier - `total_margin` number, required: Total margin - `average_margin_per_load` number, nullable: Average margin per load - `margin_percentage` number, nullable: Margin percentage ## Other responses - `422`: Validation Error --- [API](https://skmtc.dev/mentium/apis/mentium-api.md) - [All operations](https://skmtc.dev/mentium/apis/mentium-api/llms.txt) - [OpenAPI document](https://skmtc.dev/mentium/apis/mentium-api/revisions/b4ed8e59432e?raw)