Sign in
Ocean

First Booking Versions By Departure Date

This endpoint allows permissioned users to get ocean booking metrics for a given ocean lane and departure 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 booking metrics for the given ocean lane and departure 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_0_day_lead_index: an index that represents the rolling 1, 7 or 14-day average count of TEUs confirmed by ocean carriers on a 0 day lead
    • confirmed_teu_count_7_day_lead_index: an index that represents the rolling 1, 7 or 14-day average count of TEUs confirmed by ocean carriers on a 7 day lead
    • confirmed_teu_count_14_day_lead_index: an index that represents the rolling 1, 7 or 14-day average count of TEUs confirmed by ocean carriers on a 14 day lead
    • confirmed_teu_count_21_day_lead_index: an index that represents the rolling 1, 7 or 14-day average count of TEUs confirmed by ocean carriers on a 21 day lead
    • confirmed_teu_count_28_day_lead_index: an index that represents the rolling 1, 7 or 14-day average count of TEUs confirmed by ocean carriers on a 28 day lead
post/Ocean/metrics/first-bookings-by-departure-date

Headers

x-api-versionstring

Request body

originstring required
destinationstring required
start_datestring date-time required
end_datestring date-time required

Example request

{
  "origin": "USSAV",
  "destination": "All",
  "start_date": "2025-08-01",
  "end_date": "2025-08-02"
}

Response

OK

start_datestring
end_datestring

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_0_day_lead_index": {
        "one_day_avg": 123.45,
        "seven_day_avg": 987.6,
        "fourteen_day_avg": 345.6
      },
      "confirmed_teu_count_7_day_lead_index": {
        "one_day_avg": 123.45,
        "seven_day_avg": 987.6,
        "fourteen_day_avg": 345.6
      },
      "confirmed_teu_count_14_day_lead_index": {
        "one_day_avg": 123.45,
        "seven_day_avg": 987.6,
        "fourteen_day_avg": 345.6
      },
      "confirmed_teu_count_21_day_lead_index": {
        "one_day_avg": 123.45,
        "seven_day_avg": 987.6,
        "fourteen_day_avg": 345.6
      },
      "confirmed_teu_count_28_day_lead_index": {
        "one_day_avg": 123.45,
        "seven_day_avg": 987.6,
        "fourteen_day_avg": 345.6
      }
    }
  ]
}