latestSwagger 2.02026-08-1274120326.8 KB
3a995f316cda
Ocean
Last Booking Versions By Departure Date
This endpoint allows permissioned users to get ocean booking metrics for a given ocean lane and timeframe
For more information about getting access to this endpoint or using this endpoint, please reach out to our Customer Success team (cs@gosonar.com).
Returns a timeseries collection of last booking metrics for the given ocean lane and date range.
This endpoint handles the following input fields:
- origin: the Ocean Location code for the origin, required
- destination: the Ocean Location code for the destination, required
- start_date: the earliest version date of the range being requested
- end_date: the latest version date of the range being requested
Here are the output fields returned in a successful call:
- origin: an object containing the origin location details
- destination: an object containing the destination location details
- start_date: the first date in the range requested
- end_date: the last date in the range requested
- values: the collection of metrics records for the given date range
- date: the date for the metrics record
- confirmed_teu_count_global_index: an index that represents the rolling 1, 7 or 14-day average count of TEUs confirmed by ocean carriers
- confirmed_transaction_count_global_index: an index that represents the rolling 1-day or 1, 7 or 14-day average count of transactions confirmed by ocean carriers
- transit_time_days: a number that represents the rolling 1, 7 or 14-day average transit time in days
post/Ocean/metrics/last-bookings-by-departure-date
Headers
x-api-versionstring
Request body
Example request
{
"origin": "USSAV",
"destination": "All",
"start_date": "2025-08-01",
"end_date": "2025-08-02"
}Response
OK
Example response
{
"origin": {
"code": "USSAV",
"port": "USSAV",
"port_name": "Savannah",
"country": "United States of America",
"type": "Port"
},
"destination": {
"code": "USSAV",
"port": "USSAV",
"port_name": "Savannah",
"country": "United States of America",
"type": "Port"
},
"start_date": "2025-08-01",
"end_date": "2025-08-02",
"values": [
{
"date": "2025-08-01",
"confirmed_teu_count_global_index": {
"one_day_avg": 123.45,
"seven_day_avg": 987.6,
"fourteen_day_avg": 345.6
},
"confirmed_transaction_count_global_index": {
"one_day_avg": 123.45,
"seven_day_avg": 987.6,
"fourteen_day_avg": 345.6
},
"transit_time_days": {
"one_day_avg": 123.45,
"seven_day_avg": 987.6,
"fourteen_day_avg": 345.6
}
}
]
}