OBJECT
Query

GraphQL Schema definition

type Query {
#   Returns events by event_type. A maximum of 10,000 events are returned
# 
# Arguments
#   aoiId: Filter results to events that occurred within the given 
#   AOI (Area of Interest) ID (unique to the Skylight platform)
#   detectionType: See detectionType below for list of options
#   vesselCategory: Vessel category from AIS
#   countryCodes: Filter results to events that include a vessel 
#   with the given ISO 3166-1 alpha-3 country codes. Separate each code using '|'. 
#   example: USA or USA|CHN. To include vessels with no country, use code 'N/A'
#   countryCodesExclude: ISO 3166-1 alpha-3 country codes to 
#   exclude. Separate each code using '|'. example: USA or USA|CHN. To exclude 
#   vessels with no country, use code 'N/A'
#   eventTypes: See eventTypes below for list of options
#   inProgressStatus: Event is currently in progress (true or 
#   false)
#   pageSize: For paginated results, number of items to return per 
#   page
#   pageNum: For paginated results, return a specific page
#   polygon: GeoJSON spatial filter expressed as an array of 
#   geo-coordinates
#   startTime: Filter results to events that started after the 
#   specified time.  Value must be an ISO 8601 formatted timestamp
#   endTime: Filter results to events that started before the 
#   specified time.  Value must be an ISO 8601 formatted timestamp
#   vesselId: Filter results to events that contain a specific 
#   vessel by Vessel ID (unique to the Skylight platform)
events(
aoiId: String,
detectionType: DetectionType,
vesselCategory: [VesselCategory],
countryCodes: String,
countryCodesExclude: String,
eventTypes: [EventType]!,
inProgressStatus: Boolean,
pageSize: Int,
pageNum: Int,
polygon: String,
startTime: String,
endTime: String,
vesselId: String
): Events 
#   Returns a specific event by event_id
# 
# Arguments
#   eventId: Event ID (unique to the Skylight platform)
event(eventId: ID!): Event 
#   Returns satellite frames, representing the spatial extent of the data frame 
#   captured by a satellite's sensors or cameras.
#   Individual frames may contain zero or more vessel detections, including 
#   detections that have been correlated with AIS.
# 
# Arguments
#   startTime: Filter results to frames that were collected after 
#   the specified time.  Value must be an ISO 8601 formatted timestamp
#   endTime: Filter results to frames that were collected before 
#   the specified time.  Value must be an ISO 8601 formatted timestamp
#   pageSize: For paginated results, number of items to return per 
#   page
#   pageNum: For paginated results, request a specific page number
#   eventTypes: Event types to filter by
#   polygon: GeoJSON spatial filter expressed as an array of 
#   geo-coordinates. Specifying this field causes only satellite frames which 
#   overlap this polygon to be returned.
satelliteFrames(
startTime: String,
endTime: String,
pageSize: Int,
pageNum: Int,
eventTypes: [FrameEventType],
polygon: [[[Float]]]
): SatelliteFrames 
#   Returns satellite frame by frameId
# 
# Arguments
#   frameId: Frame ID (unique to the Skylight platform)
satelliteFrame(frameId: String): SatelliteFrame 
#   Returns vessel by vesselId
# 
# Arguments
#   vesselId: Vessel ID (unique to the Skylight platform)
#   mmsi: Maritime Mobile Service Identity number
#   imo: International Maritime Organization number
#   callSign: Filter to vessels with a specific call sign as 
#   reported over AIS static messages.  Used for ship radio communications.
vessel(vesselId: String, mmsi: Int, imo: Int, callSign: String): Vessel 
#   Returns vessel Last Known Position (LKP) by vesselId
# 
# Arguments
#   vesselId: Vessel ID (unique to the Skylight platform)
vesselLkp(vesselId: String!): VesselLkp 
#   Get access Bearer token for authentication. This token is valid for 24 hours, or 
#   until another login session is started.
# 
# Arguments
#   username: User email address
#   password: User password
getToken(username: String!, password: String!): Token 
#   Get Areas of Interest (AOIs) associated with the active user
aoi: [AOI] 
#   Get vessel tracks by eventId. Track segments are generated from AIS positions, 
#   and represent a vessel's movement. Tracks display 48 hours prior to the time of 
#   the event itself, and up to 48 hours after the event.
# 
# Arguments
#   eventId: Event ID (unique to the Skylight platform) 
trackByEventId(eventId: String!): [Track] 
}
Require by

This element is not required by anyone
Query

link GraphQL Schema definition

link Require by

GraphQL Schema definition

Require by
