PRproject44
TL: Connected Capacity

Search for carrier performance

Returns tracking statistics for carriers across all lanes served by that carrier

post/api/v4/tl/connected-capacity/carriers/search

Request

Request body

minimumDeliveryScheduleReliabilityinteger

Return only results where the percentage of tracked shipments in the past 365 days that were delivered within 2 hours of the scheduled time is above the given value

minimumPickupScheduleReliabilityinteger

Return only results where the percentage of tracked shipments in the past 365 days that were picked up within 2 hours of the scheduled time is above the given value

minimumTrackingPercentageinteger

Return only results where the percentage of tracked shipments in the past 365 days which received at least one tracking update is above the given value

minimumVolume'VOLUME_0_TO_10_SHIPMENTS' | 'VOLUME_11_TO_50_SHIPMENTS' | 'VOLUME_51_TO_100_SHIPMENTS' | 'VOLUME_101_OR_MORE_SHIPMENTS'

Return only results where the number of shipments tracked in the past 365 days is above the given value

sortBy'SHIPMENT_VOLUME' | 'RECENT_SHIPMENT_VOLUME' | 'DELIVERY_SCHEDULE_RELIABILITY' | 'PICKUP_SCHEDULE_RELIABILITY' | 'PERCENT_TRACKED' | 'RECENT_PERCENT_TRACKED'

Use the following metric to sort results. Defaults to <code>SHIPMENT_VOLUME</code>

sortDirection'ASC' | 'DESC'

Sort results by ascending or descending values of the selected metric. Defaults to <code>DESC</code> (descending).

Response

OK

Changes

No recorded changes to this operation across all 1 revision of this API.