MEmentium
v2
tms
v2
tms
dashboard

Get Tms Dashboard Metrics

Get comprehensive TMS dashboard metrics with optimized performance.

Returns all key metrics for the outreach dashboard:

Load Inventory:

  • Total active loads (from TMS)
  • Loads with offers (not yet booked)

Outreach Performance:

  • Offers sent
  • Unique carriers contacted
  • Response rate
  • Average offers per load

Conversion Metrics:

  • Loads booked via Mentium
  • Booking rate
  • Accept rate
  • Acceptance-to-booking rate

Financial Performance (booked loads only):

  • Average margin percentage
  • Average margin amount
  • Total revenue managed
  • Total profit generated
get/v2/tms/dashboard/metrics

Request

  • Base URL
    https://api.mentium.io (the document declares no server; this is the origin it was published from)
  • Auth
    HTTP bearer

Query parameters

integration_connection_idstring required

TMS integration connection UUID

start_datestring date-time nullable

Start date for filtering metrics

end_datestring date-time nullable

End date for filtering metrics

Headers

mentium-workspace-idstring nullable

Response

Successful Response

total_active_loadsinteger required

Count of loads with ACTIVE mentium_status

loads_with_offersinteger required

Count of loads with offers sent that are not yet booked

offers_sentinteger required

Total number of carrier offers sent

unique_carriers_contactedinteger required

Number of unique carriers who received offers

response_ratenumber required

Percentage of offers that received inbound messages (0-100)

avg_offers_per_loadnumber required

Average number of offers sent per load

loads_bookedinteger required

Number of loads booked via Mentium (CarrierOffer status = BOOKED)

booking_ratenumber required

Percentage of offers that resulted in bookings (0-100)

accept_ratenumber required

Percentage of offers that were accepted by carriers (0-100)

acceptance_to_booking_ratenumber required

Percentage of accepted offers that resulted in bookings (0-100)

avg_margin_percentagenumber required

Average margin percentage on booked loads

avg_margin_amountstring required

Average margin amount in dollars on booked loads

total_revenue_managedstring required

Total customer revenue from Vortex for the selected timeframe (converted to org base currency)

total_profitstring required

Total margin from Vortex for the selected timeframe (converted to org base currency)

Example response

{
  "accept_rate": 15.5,
  "acceptance_to_booking_rate": 64.3,
  "avg_margin_amount": "250.00",
  "avg_margin_percentage": 12.5,
  "avg_offers_per_load": 3.75,
  "booking_rate": 10,
  "loads_booked": 45,
  "loads_with_offers": 105,
  "offers_sent": 450,
  "response_rate": 32.5,
  "total_active_loads": 150,
  "total_profit": "11250.00",
  "total_revenue_managed": "135000.00",
  "unique_carriers_contacted": 85
}

Changes

No recorded changes to this operation across all 2 revisions of this API.