tms

profitability

Get Profitability For Window

Profitability computed live for a window no snapshot covers (all time, today, a custom range).

Same figures as the snapshot, by booked-at, with period null. Prior-window totals cover the equal-length window before a custom range; all time has none.

get/v2/tms/profitability/window

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_datetimestring date-time nullable

Inclusive window start (timezone-aware ISO-8601). Requires end_datetime_exclusive.

end_datetime_exclusivestring date-time nullable

Exclusive window end (timezone-aware ISO-8601). Requires start_datetime.

all_timeboolean

Every load booked so far. Excludes the explicit bounds.

Headers

mentium-workspace-idstring nullable

Response

Successful Response

existsboolean required

False when the cron has not yet computed this period

period'SEVEN_DAYS' | 'THIRTY_DAYS' | 'NINETY_DAYS'

Trailing window a profitability snapshot is computed over.

currencystring required

Organization base currency of all amounts

computed_atstring date-time nullable

When the snapshot was computed

window_start_datetimestring date-time nullable

window_end_datetime_exclusivestring date-time nullable

total_loadsinteger

loads_with_financialsinteger

profitable_loadsinteger

unprofitable_loadsinteger

profitable_percentagenumber nullable

profitable_loads / loads_with_financials * 100

unprofitable_percentagenumber nullable

unprofitable_loads / loads_with_financials * 100

total_revenuenumber

total_marginnumber

total_lossnumber

average_marginnumber nullable

Average margin per load with financials

margin_percentagenumber nullable

total_margin / total_revenue * 100

average_margin_per_milenumber nullable

total_margin / total carrier miles (RPM-style)

average_time_to_book_secondsnumber nullable

slow_booked_loadsinteger

slow_booked_lossnumber

slow_booked_percentagenumber nullable

slow_booked_loss / total_loss * 100

lead_time_excluded_loadsinteger

Loads with booking+pickup time booked at/after pickup, excluded from buckets

lead_time_excluded_unprofitable_loadsinteger

Of lead_time_excluded_loads, how many lost money

prior_total_revenuenumber nullable

prior_total_marginnumber nullable

prior_total_lossnumber nullable

Changes

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