API Reference

vesselPropertyChanges

Query vessels' historical and fused properties to identify suspicious and/or frequent changes in a selected time range of up to 1 year.

Query Schema

type Query {
   vesselPropertyChanges(input: VesselPropertyChangesInput!): VesselPropertyChangesConnection!
}

Arguments

NameTypeDescription
inputVesselPropertyChangesInput!Sets the time range and vessel IDs of the vessel whose property changes are returned by the vesselPropertyChanges query.

Schema

input VesselPropertyChangesInput {
  vesselIdOrImo: String!
  timeRange: ClosedDateTimeRangeInput!
  limit: PositiveInt! = 100
  offset: NonNegativeInt! = 0
}

VesselPropertyChangesInput Fields

NameTypeDescription
limitPositiveInt!The maximal number of records to return.
offsetNonNegativeInt!The number of returned records to skip from the beginning of the record list.
timeRangeClosedDateTimeRangeInput!The time range within which the property changes have occurred.
timeRangeString!The identity of the vessels whose property changes are returned.

Returns

NameDescription
VesselPropertyChangesConnection!The property changes in the vessels specified by the vesselPropertyChanges query input (the VesselPropertyChangesConnection object constitutes the response of the vesselPropertyChanges query).

VesselPropertyChangesConnection Fields

NameTypeDescription
nodes[VesselPropertyChangesItem!]The collection of all VesselPropertyChangesItem nodes. Each node contains the changes in properties of a single vessel.
totalCountNonNegativeInt!The number of nodes.

Example Code

Sample Query

query VesselPropertyChanges($input: VesselPropertyChangesInput!) {
  vesselPropertyChanges(input: $input) {
    totalCount
    nodes {
      vesselId
      timestamp
      eta {
        oldValue
        newValue
      }
      size {
        oldValue
        newValue
      }
      draught {
        oldValue
        newValue
      }
      name {
        oldValue
        newValue
      }
      callsign {
        oldValue
        newValue
      }
      destination {
        oldValue
        newValue
      }
      imo {
        oldValue
        newValue
      }
      class {
        oldValue
        newValue
      }
      mmsi {
        oldValue
        newValue
      }
    }
  }
}

Variables

{
 "input": {
   "vesselIdOrImo": "5905c34899570258886e786c",
   "timeRange": {
     "from": "2021-01-01T00:00:00.011Z",
     "to": "2022-01-01T00:00:00.000Z"
   },
   "limit": 100,
   "offset": 0
 },
}

Response

{
  "data": {
    "vesselPropertyChanges": {
      "totalCount": 206,
      "nodes": [
        {
          "vesselId": "5905c34899570258886e786c",
          "timestamp": "2021-01-10T13:48:42.000Z",
          "eta": {
            "oldValue": "2021-01-07T17:00:00.000Z",
            "newValue": "2021-01-11T06:00:00.000Z"
          },
          "size": null,
          "draught": {
            "oldValue": null,
            "newValue": 8.9
          },
          "name": null,
          "callsign": null,
          "destination": {
            "oldValue": "TNBIZ",
            "newValue": "MALTA FOR ORDERS"
          },
          "imo": null,
          "class": {
            "oldValue": null,
            "newValue": "Tanker"
          },
          "mmsi": null
        },
        {
          "vesselId": "5905c34899570258886e786c",
          "timestamp": "2021-01-10T21:51:17.000Z",
          "eta": {
            "oldValue": "2021-01-11T06:00:00.000Z",
            "newValue": "2021-01-11T10:00:00.000Z"
          },
          "size": null,
          "draught": null,
          "name": null,
          "callsign": null,
          "destination": {
            "oldValue": "MALTA FOR ORDERS",
            "newValue": "AUGUSTA OPL"
          },
          "imo": null,
          "class": null,
          "mmsi": null
        },
        .
        .
        .
      ]
    }
  }
}