Get Global Dashboard Metrics
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)
Request
- Base URLhttps://api.mentium.io (the document declares no server; this is the origin it was published from)
- AuthHTTP bearer
Query parameters
TMS integration connection UUID
Current datetime (UTC) sourced from request for consistency
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])
Calendar time window type in which to calculate metrics
- Standard types (DAY, WEEK, MONTH, QUARTER, YEAR): Enables historical/projected trends
- CUSTOM: Arbitrary date range for the focus timeframe
Calender time unit type in which to average metrics E.g. revenue/week
Calender time unit type in which to average metrics
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
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)
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]
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
Response
Successful Response
Example response
{
"timeframe_metrics": [
{
"elapsed_working_days": 21,
"organization_metrics": {
"average_loads_per_interval": 169.62,
"average_margin_per_interval": 34712.2,
"average_margin_per_load": 204.68,
"average_revenue_per_interval": 311546.92,
"average_revenue_per_load": 1836.74,
"margin_percentage": 11.14,
"projected_total_loads": 3562,
"projected_total_margin": 728956.14,
"projected_total_revenue": 6542485.25,
"total_loads": 3562,
"total_margin": 728956.14,
"total_revenue": 6542485.25
},
"remaining_working_days": 0,
"timeframe_end_datetime_exclusive": "2024-12-01T00:00:00Z",
"timeframe_start_datetime": "2024-11-01T00:00:00Z",
"timeframe_type": "MONTH"
},
{
"elapsed_working_days": 23,
"organization_metrics": {
"average_loads_per_interval": 184.78,
"average_margin_per_interval": 35319.38,
"average_margin_per_load": 191.14,
"average_revenue_per_interval": 314546.43,
"average_revenue_per_load": 1701.88,
"margin_percentage": 11.23,
"projected_total_loads": 4250,
"projected_total_margin": 812345.67,
"projected_total_revenue": 7234567.89,
"total_loads": 4250,
"total_margin": 812345.67,
"total_revenue": 7234567.89
},
"remaining_working_days": 0,
"timeframe_end_datetime_exclusive": "2025-01-01T00:00:00Z",
"timeframe_start_datetime": "2024-12-01T00:00:00Z",
"timeframe_type": "MONTH"
},
{
"elapsed_working_days": 9,
"organization_metrics": {
"average_loads_per_interval": 194.78,
"average_margin_per_interval": 38242.06,
"average_margin_per_load": 196.34,
"average_revenue_per_interval": 343377.06,
"average_revenue_per_load": 1763.08,
"margin_percentage": 11.14,
"projected_total_loads": 3331,
"projected_total_margin": 653939.15,
"projected_total_revenue": 5871747.73,
"total_loads": 1753,
"total_margin": 344178.5,
"total_revenue": 3090393.54
},
"remaining_working_days": 12,
"sales_representative_metrics": [
{
"assigned_loads": 202,
"assigned_loads_handled_by_others": 0,
"assigned_loads_handled_by_others_percentage": 0,
"assigned_loads_handled_by_self": 202,
"assigned_loads_handled_by_self_percentage": 100,
"average_bids_placed_per_interval": 19.22,
"average_bids_placed_per_load": 0.85,
"average_loads_per_interval": 22.67,
"loads_per_interval_goal": 16,
"margin_percentage": 11.14,
"name": "Marcus Hix",
"non_assigned_loads_handled_by_self": 2,
"non_assigned_loads_handled_by_self_percentage": 0.98,
"rolled_percentage": 0,
"total_bids_placed": 173,
"total_carriers_booked": 148,
"total_loads": 204,
"total_margin": 40071.61,
"total_revenue": 359691.96
}
],
"timeframe_end_datetime_exclusive": "2025-02-01T00:00:00Z",
"timeframe_start_datetime": "2025-01-01T00:00:00Z",
"timeframe_type": "MONTH",
"top_carriers_metrics": [
{
"average_loads_per_interval": 16.33,
"average_margin_per_load": 119.89,
"average_spend_per_load": 2240.83,
"margin_percentage": 5.35,
"name": "LARRY WILLIAMS TRUCKING LLC",
"top_lanes": [
{
"average_margin_per_load": 119.89,
"destination_city": "DALLAS",
"destination_state": "TX",
"margin_percentage": 5.35,
"source_city": "CHICAGO",
"source_state": "IL",
"total_loads": 25,
"total_margin": 2997.25,
"total_spend": 56020.75
}
],
"total_loads": 147,
"total_margin": 17623.8,
"total_spend": 329472.67
}
]
},
{
"elapsed_working_days": 0,
"organization_metrics": {
"total_loads": 0,
"total_margin": 0,
"total_revenue": 0
},
"remaining_working_days": 20,
"timeframe_end_datetime_exclusive": "2025-03-01T00:00:00Z",
"timeframe_start_datetime": "2025-02-01T00:00:00Z",
"timeframe_type": "MONTH"
}
]
}Changes
No recorded changes to this operation across all 2 revisions of this API.