Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

For our example we will run a query that returns Dark Rendezvous and Standard Rendezvous events between April May 1, 2023 and April May 2, 2023. The results will be limited to only 1 page where each page returns 5 events. The following arguments are used to filter the results:

  1. eventTypes: [standard_rendezvous, dark_rendezvous]

  2. startTime: “2023-05-01T00:00:00”

  3. endTime: “2023-05-02T00:00:00”

  4. pageNum: 1

  5. pageSize: 5

Other arguments are available as shown below. You will find the list of all arguments allowed to use as the input parameter for “events” and other fields here.

...

  • event_id

  • event_type

  • start

  • end

  • vessels:

    • vessel_0

      • country_filter

      • display_country

      • name

      • mmsi

      • vessel_id

    • vessel_1

      • country_filter

      • display_country

      • name

      • mmsi

      • vessel_id

Below is an example of items that are available as an output for Event Object

...

Running the query gives a response similar to the below:

...

Event Type Specific Response

...