CloudAhoy Flight Return Object API

The Flights Object is returned by any endpoint requesting flight data. For information on retrieving a flights object, review documentation for a specific endpoint.

- CloudAhoy User’s Flights API
- CloudAhoy Retrieve by Tail API

Flight Return Object

Successful GET requests to several endpoints will return a 200 status code and an array of flight objects, matching the filter parameters if any are provided. If the request finds no flights, an empty array will be returned.

Any invalid parameters will result in a 400 response status code.

Success responses will also contain the following custom HTTP headers:

Header	Type	Description
`ca-flight-count`	integer	The total number of the user's debriefable flights. This figure excludes any flights that are too short to analyze, or in which there were no airborne segments detected
`ca-err-omitted-count`	integer	The total number of the user's flights that are not debriefable because they are too short to analyze or contain no airborne segments
`ca-filtered-flight-count`	integer	The number of debriefable flights matching the filters specified
`ca-has-more`	boolean	True if one or more pages of flights are available. False if not.
`ca-maneuver-scores`	boolean	Present and `true` if the maneuvers returned may include CFIA scores. Not present if maneuver CFIA scores will not be available

Flight Object

Each entry returned by an endpoint has the following properties:

Property	Type	Description
`flightId`	string	Identifier of this flight, unique to this user Note: This flightId is not globally unique; it is only unique within the user's account.
`url`	string	URL to access this flight
`thumbnailUrl`	string	URL of the thumbnail of this flight. If a width other than 600px has been specified, the thumbnail image will not be created until the first time it is accessed via this URL.
`time`	double	The date/time the flight starts, in seconds from epoch GMT
`duration`	double	The length of the flight, in seconds
`userRole`	string	The role the user had in the flight. Currently one of: `Pilot`, `Copilot`, `Student`, `Instructor`, `Passenger`, `Safety Pilot`, `Examiner`
`airports`	array of Airport objects	Array of airport objects, from initial airport to final airport in the order in which they were visited, with adjacent duplicates removed
`aircraft`	Aircraft object	Object describing the aircraft flown
`crew`	array of Crew objects	Array crew objects, describing the crew members on the flight
`remarks`	string	The user's remarks about the flight
`maneuvers`	array of Maneuver objects	The maneuvers performed in the flight. Empty array if CloudAhoy didn't detect any maneuvers.
`cfiaScore`	number or null	The flight's CFI Assistant score (only present if the user has a CloudAhoy PRO account, or via arrangement with CloudAhoy)

Airport Object

The airport property in each flight object has the following properties:

Property	Type	Description
`icao`	string	The airport ICAO, or '????' if unknown
`name`	string	The airport name, or '????' if unknown

Aircraft Object

The aircraft property in each flight object has the following properties:

Property	Type	Description
`registration`	string	The aircraft's registration number
`make`	string	The aircraft's make, or 'UNKNOWN'
`model`	string	The aircraft's model, or 'UNKNOWN'

Crew Object

Each entry in the crew property in each flight object has the following properties:

Property Type Description

name string Name of the crew member

role string Role of the crew member, currently one of: Pilot, Copilot, Student, Instructor, Passenger, Safety Pilot, Examiner

currentUser

integer

1 if the crew member corresponds to the user for which flights were returned,

0 otherwise.

Maneuver Object

Each entry in the maneuvers property in each flight object has the following properties:

Property	Type	Description
`maneuverId`	string	Identifier of the maneuver, unique within the flight
`url`	string	Url to the flight, preconfigured for this maneuver
`maneuverType`	string	The type of maneuver, such as `departure` and `iap missed`
`code`	string	The maneuver's code (see the list of maneuvers for the current maneuver codes)
`label`	string	The label for the maneuver, as displayed in CloudAhoy
`cfiaScore`	number	The CFIA score for this maneuver. Only available for scorable maneuvers If the user has a Pro-level account, (or on prior arrangement with CloudAhoy). `null` otherwise.

List of Maneuver Codes

The tables below list the current maneuvers CloudAhoy identifies.

Basic

Code	Label
`chandelle`	Chandelle
`iap`	Instrument approach
`land`	Visual approach + land instrument approach + land traffic pattern + land
`lineupAndWait`	Lineup and wait
`missedApproach`	Visual approach + missed instrument approach + missed traffic pattern + missed
`oscarPattern`	Oscar pattern
`overhead approach`	Overhead approach
`slowFlight`	Slow flight
`spiral`	Up/down spiral
`stall`	Stall
`stopAndGo`	Visual approach + stop and go instrument approach + stop and go traffic pattern + stop and go
`sTurns`	S-turns
`takeoff`	Takeoff
`touchAndGo`	Visual approach + touch and go instrument approach + touch and go traffic pattern + touch and go
`trafficPattern`	Traffic pattern
`turbulence`	Turbulence
`turn360`	Right/left 360

Glider-specific

Code	Label
`glide`	Glide
`tow`	Tow
`thermalling`	Thermalling

Rotorcraft-specific

Code	Label
`autoRotate`	auto-rotate
`hover`	hover

List of Maneuver Types

Maneuver Type	Type	Description
`go around`	string	Go-Around
`visual final`	string	Visual Straight-in
`land`	string	Normal Landing
`touch and go`	string	Touch-and-Go Procedure
`closed traffic pattern`	string	Normal Pattern
`takeoff`	string	Takeoff
`departure`	string	Departure
`iap loc bc final`	string	Localizer BC
`lazy eight`	string	Lazy 8
`cuban eight`	string	Cuban 8
`cloverleaf`	string	Cloverleaf
`ailron roll`	string	Aileron Roll
`high g 180`	string	G-Awareness / Exercise
`split s`	string	Split S
`loop`	string	Loop
`barrel roll`	string	Barrel Roll
`slow flight`	string	Slow Flight
`slow flight and stall`	string	Slow Flight w/ a stall
`immelman`	string	Immelmann
`iap gps final`	string	GPS Final
`iap vor final`	string	VOR/TCN Final
`iap circling`	string	Circling Approach
`iap loc final`	string	Localizer Final
`iap full approach`	string	Instrument Approach (Full Procedure)
`iap missed`	string	Missed Approach
`iap vector approach`	string	Instrument Approach (Vectors)
`turn 360`	string	Steep Turns
`iap ils final`	string	ILS Final

Last Updated: July 05, 2023 15:48

Was this article helpful?

SUPPORT CENTER