Get a lane coverage report
The /v2/lane/reports/get/coverage
endpoint allows you get a breakdown of which carriers have covered a particular lane for you. These carriers are the first to be notified when you post a load announcement for this lane.
For TMS integrators, use this to give your users a list of recent high-relevance carriers to work from when they are at a decision point in your software that is pertinent to this lane.
This endpoint must be called from the server side to avoid compromising your secret API key. Do not use your secret key in client-side JavaScript.
HTTP request
Method
URL
GET
Required parameters
Name
Type
Value(s)
pk
string
Your public API key
sk
string
Your secret API key
zip_a
string
Point A zip code
zip_b
string
Point B zip code
Return values
This endpoint returns an object with the fields carriers
and status
. The carriers
field is an array containing containing one or more objects, each with the following keys and values.
Key
Type
Value
business_name
string
The carrier's business name.
phone
string
The carrier's dispatch phone number.
email
string
The carrier's dispatch email.
Example response
{ "carriers": [ { "business_name": "Acme Trucking Inc", "phone": "5558675309", "email": "dispatch@acmetrucking.com" }, { "business_name": "Madeupname Trucking Inc", "phone": "5558675310", "email": "dispatch@madeupnametrucking.com" }, { "business_name": "Fictional Freight LLC", "phone": "5558675311", "email": "dispatch@fictionalfreightllc.com" } ], "status": 200 }