Overview
This is the data dictionary where you can find out what each field means, and also which fields are filterable and will appear in CSV files.
Here is a guide of what each column means:
- Name of field in CSV file: These are the columns that will appear on the extracts generated. This consists of the selectable fields and more such as leg/segment details.
- Description: A brief of what that column indicates
- Example: An example of what the data for that column can be like
For Airport and Airline mappings, please refer to this page : Helpful Resources
Data Dictionary
Searches data set
Column name |
Description |
Example |
Configuration Group |
Type |
Mode |
---|---|---|---|---|---|
Guid | A unique record ID for debugging and referencing | 7587FAD4-1E86-4F28-9D08-E11181BD059A | Default | string | REQUIRED |
Timestamp | Event timestamp | 2021-08-10 12:12 | Default | datetime | REQUIRED |
Market | The market (Skyscanner domain) a user has selected | DE | Default | string | REQUIRED |
OriginAirport |
The airport of the first leg's first segment. Empty in case of city search |
LHR | Default | string | OPTIONAL |
OriginCity | The city of the first leg's origin | LON | Default | string | REQUIRED |
OriginCountry | The country of the first leg's origin | KR | Default | string | REQUIRED |
DestinationAirport |
The airport of the first leg's last segment. Empty in case of city search. Empty in case of MULTI_CITY trip kind |
JFK | Default | string | OPTIONAL |
DestinationCity |
The city of the first leg's destination Empty in case of MULTI_CITY trip kind |
NYC | Default | string | OPTIONAL |
DestinationCountry |
The country of the first leg's destination Empty in case of MULTI_CITY trip kind |
FR | Default | string | OPTIONAL |
Locale | User-locale settings of the user's browser | en-GB | Default | string | REQUIRED |
CabinClass | Cabin class type, e.g. "ECONOMY", "BUSINESS", "PREMIUMECONOMY" in the search query | ECONOMY | Default | string | REQUIRED |
Currency | Currency of the search query | GBP | Default | string | REQUIRED |
Kind | The kind of flight searched for (one of "RETURN", "ONE_WAY" or "MULTI_CITY") | RETURN | Default | string | REQUIRED |
DepartureDate | Date of first segment departure | 2021-08-10 | Default |
date |
REQUIRED |
ReturnDate |
Date of last segment departure Empty in case of MULTI_CITY or ONE_WAY trip kind |
2021-08-10 | Default |
date |
OPTIONAL |
TripLengthNights |
Total length of stay (nights) Empty in case of MULTI_CITY or ONE_WAY trip kind |
14 | TripProperties | integer | OPTIONAL |
TravelHorizonDays | Search horizon in days (a difference between departure date and search date) | 60 | TripProperties | integer | REQUIRED |
TravelType |
One of "DOMESTIC" or "INTERNATIONAL" Empty in case of MULTI_CITY trip kind |
DOMESTIC | TripProperties | string | OPTIONAL |
TravelDistanceKm |
Travel distance (great-circle distance) in km between the OriginCity and DestinationCity Empty in case of MULTI_CITY trip kind |
123 | TripProperties | integer | OPTIONAL |
PassengerAdult | Number of adult passengers | 2 | PassengerInfo | integer | REQUIRED |
PassengerChild | Number of child passengers | 0 | PassengerInfo | integer | REQUIRED |
PassengerInfant | Number of infant passengers | 1 | PassengerInfo | integer | REQUIRED |
Device | A user platform (one of "DESKTOP", "MOBILE", "TABLET") | DESKTOP | DeviceInfo | string | OPTIONAL |
BrowserName | Name of the browser used. If empty on mobile, it's a native app (Android or iOS); otherwise, mobile web. | Chrome | DeviceInfo | string | OPTIONAL |
BrowserVersion | Version of the browser used | 35.0.1 | DeviceInfo | string | OPTIONAL |
OSName | Name of the OS of the user device | Android | DeviceInfo | string | OPTIONAL |
OSVersion | Version of the OS of the user device | 11.0.3 | DeviceInfo | string | OPTIONAL |
UserCountryCode | User country code | US | userLocation | string | OPTIONAL |
UserCountryName | User country name | United States | userLocation | string | OPTIONAL |
UserRegionName | User region name | California | userLocation | string | OPTIONAL |
UserCityName | User city name | London | userLocation | string | OPTIONAL |
UserDistrictName | User district name | Camden | userLocation | string | OPTIONAL |
UserLongitude | Longitude of the user location | 0.233333007 | userLocation | string | OPTIONAL |
UserLatitude | Latitude of the user location | -96.74082947 | userLocation | string | OPTIONAL |
CorrelationIds | ID to correlate searches with redirects. IDs are double-colon (::) separated, with same-user, same-search condensed into a single row | 7587FAD4-1E86-4F28-9D08-E11181BD059A | correlationIds | string | OPTIONAL |
SessionId | ID to identify user sessions resulting in multiple events (searches and redirects) | NzU4N0ZBRDQtMUU4Ni00RjI4LTlEMDgtRTExMTgxQkQwNTlBc2Q= | correlationIds | string | OPTIONAL |
LegsCount | Number of journeys in a trip (1 for one-way, 2 for roundtrip, 3+ for multicity) | 4 | FlightInfo | integer | REQUIRED |
Leg_0..6_Date | Leg's Date of flight | 2021-08-10 | FlightInfo | date | REQUIRED |
Redirects data set
Column name |
Description |
Example |
Configuration Group |
Type |
Mode |
---|---|---|---|---|---|
Guid | A unique record ID for debugging and referencing | 7587FAD4-1E86-4F28-9D08-E11181BD059A | Default | string | REQUIRED |
Timestamp | Event timestamp | 2021-08-10 12:12 | Default | datetime | REQUIRED |
Market | The market (Skyscanner domain) a user has selected | DE | Default | string | REQUIRED |
OriginAirport | The airport of the first leg's first segment. | LHR | Default | string | REQUIRED |
OriginCity | The city of the first leg's origin. | LON | Default | string | REQUIRED |
OriginCountry | The country of the first leg's origin. | KR | Default | string | REQUIRED |
DestinationAirport |
The airport of the first leg's last segment. Empty in case of MULTI_CITY trip kind |
JFK | Default | string | OPTIONAL |
DestinationCity |
The city of the first leg's destination. Empty in case of MULTI_CITY trip kind |
NYC | Default | string | OPTIONAL |
DestinationCountry |
The country of the first leg's destination. Empty in case of MULTI_CITY trip kind |
FR | Default | string | OPTIONAL |
Locale | User-locale settings of the user's browser | en-GB | Default | string | REQUIRED |
CabinClass | Cabin class type, e.g. "ECONOMY", "BUSINESS", "PREMIUMECONOMY" in the search query | ECONOMY | Default | string | |
Currency | Currency of the search query | GBP | Default | string | REQUIRED |
Kind | The kind of flight searched for (one of "RETURN", "ONE_WAY" or "MULTI_CITY") | RETURN | Default | string | REQUIRED |
DepartDate | Date of first segment departure | 2021-08-10 | Default | date | REQUIRED |
ReturnDate |
Date of the last segment departure Empty in case of MULTI_CITY or ONE_WAY trip kind |
2021-08-10 | Default | date | OPTIONAL |
TripLengthNights |
Total length of travel (nights) 0 in case of ONE_WAY |
14 | TripProperties | integer | REQUIRED |
TravelHorizonDays | Redirect horizon in days (a difference between departure date and redirect date) | 60 | TripProperties | integer | REQUIRED |
TravelType |
One of "DOMESTIC" or "INTERNATIONAL" Empty in case of MULTI_CITY trip kind |
DOMESTIC | TripProperties | string | OPTIONAL |
TravelDistanceKm |
Travel distance (great-circle distance) in km between the OriginCity and DestinationCity Empty in case of MULTI_CITY trip kind |
123 | TripProperties | integer | OPTIONAL |
PassengerAdult | Number of adult passengers | 2 | PassengerInfo | integer | REQUIRED |
PassengerChild | Number of child passengers | 0 | PassengerInfo | integer | REQUIRED |
PassengerInfant | Number of infant passengers | 1 | PassengerInfo | integer | REQUIRED |
Device | A user device (one of "DESKTOP", "MOBILE", "TABLET") | DESKTOP | DeviceInfo | string | OPTIONAL |
BrowserName | Name of the browser used. If empty on mobile, it's a native app (Android or iOS); otherwise, mobile web. | Chrome | DeviceInfo | string | OPTIONAL |
BrowserVersion | Version of the browser used | 35.0.1 | DeviceInfo | string | OPTIONAL |
OSName | Name of the OS of the user device | Android | DeviceInfo | string | OPTIONAL |
OSVersion | Version of the OS of the user device | 11.0.3 | DeviceInfo | string | OPTIONAL |
ProviderType | One of "AIRLINE", "TRAVEL_AGENT" | AIRLINE | OfferInfoBasic | string | REQUIRED |
RedirectType |
One of "ADS", "ORGANIC" for own brand(s) clicks. Empty in case of competitor redirects This is only applicable to direct suppliers on Skyscanner |
ORGANIC | OfferInfoBasic | string | OPTIONAL |
ItineraryID | Skyscanner's unique Itinerary ID | 12461-11389-2109060550-2109060705--31734 | OfferInfoDetailed | string |
OPTIONAL |
ItineraryPosition | The itinerary position in the search results is ranked numerically, with '0' representing the highest possible position. | 3 | OfferInfoDetailed | integer |
OPTIONAL |
ItinerarySortType | One of "CHEAPEST", "BEST", "FASTEST" | CHEAPEST | OfferInfoDetailed | string |
OPTIONAL |
ProviderRank | The provider rank on the selection screen indicates the order of offers, with '0' representing the top-ranked option, which features the lowest price available | 2 | OfferInfoDetailed | integer |
OPTIONAL |
SelfTransfer |
Combinations of flights, where travellers may need to check in separately for each connecting flight. One of TRUE or FALSE |
TRUE | FlightInfoDetailed | string |
REQUIRED |
ProviderIntel |
Your brand(s) name as a provider (if applicable). Indicates if a user redirected to your brand or not. One of <YourBrand1.com>,...,<YourBrandN.com>" Empty in case of competitor redirects This is only applicable to direct suppliers on Skyscanner |
YourBrand.com | OfferInfoDetailed | string | OPTIONAL |
PriceUserCurrency | Total basket value in user currency | 123.3 | PriceInfo | float | REQUIRED |
PriceUserCurrencyPerPax | Average basket value per passenger in user currency | 50.3 | PriceInfo | float | REQUIRED |
PriceCustomCurrency | Total basket value in subscription currency | 123.3 | PriceInfo | float | REQUIRED |
PriceCustomCurrencyPerPax | Average basket value per passenger in subscription currency | 50.3 | PriceInfo | float | REQUIRED |
SearchLowestPriceRatio | Ratio between a redirect price and the lowest price for the whole search (typically ≥ 1) | 3.2 | PriceInfo | float | REQUIRED |
ItineraryLowestPriceRatio | Ratio between a redirect price and the lowest price for selected itinerary (typically ≥ 1) | 1.2 | PriceInfo | float | REQUIRED |
PartnerQuouteIds |
Custom partner quote ID This is only applicable to travel agents on Skyscanner |
123457890asdf | PartnerquouteIds | string | OPTIONAL |
UserCountryCode | User country code | US | UserLocation | string | OPTIONAL |
UserCountryName | User country name | United States | UserLocation | string | OPTIONAL |
UserRegionName | User region name | California | UserLocation | string | OPTIONAL |
UserCityName | User city name | London | UserLocation | string | OPTIONAL |
UserDistrictName | User district name | Camden | UserLocation | string | OPTIONAL |
UserLongitude | Longitude of the user location | 0.233333007 | UserLocation | string | OPTIONAL |
UserLatitude | Latitude of the user location | -96.74082947 | UserLocation | string | OPTIONAL |
CorrelationIds | ID to correlate searches with redirects. IDs are double-colon (::) separated, with same-user, same-search condensed into a single row | 7587FAD4-1E86-4F28-9D08-E11181BD059A | CorrelationIds | string | OPTIONAL |
SessionId | ID to identify user sessions resulting in multiple events (searches and redirects) | NzU4N0ZBRDQtMUU4Ni00RjI4LTlEMDgtRTExMTgxQkQwNTlBc2Q= | CorrelationIds | string | OPTIONAL |
LegsCount | Number of journeys in a trip (1 for one-way, 2 for roundtrip, 3+ for multicity) | 2 | FlightInfoBasic | integer | REQUIRED |
Leg_0..6_Segment_0..15_OriginIATA | Segment's Origin IATA code | LHR | FlightInfoBasic | string | REQUIRED |
Leg_0..6_Segment_0..15_OriginName | Segment's Origin location name | Naples Airport | FlightInfoBasic | string | REQUIRED |
Leg_0..6_Segment_0..15_DestinationIATA | Segment's Destination IATA code | MAD | FlightInfoBasic | string | REQUIRED |
Leg_0..6_Segment_0..15_DestinationName | Segment's Destination location name | Madrid airport | FlightInfoBasic | string | REQUIRED |
Leg_0..6_StopsCount | A number of stops in a leg (0, 1 or more) | 1 | FlightInfoBasic | integer | REQUIRED |
Leg_0..6_Segment_0..15_DepartureTimestamp |
Segment's timestamp of departure May not be guaranteed for some segments |
2021-08-10 12:12 | FlightInfoDetailed | datetime | OPTIONAL |
Leg_0..6_Segment_0..15_ArrivalTimestamp |
Segment's timestamp of arrival May not be guaranteed for some segments |
2021-08-10 12:12 | FlightInfoDetailed | datetime | OPTIONAL |
Leg_0..6_Segment_0..15_MarketingCarrierIATA | Segment's Marketing carrier code | BA | FlightInfoDetailed | string | OPTIONAL |
Leg_0..6_Segment_0..15_OperatingCarrierIATA | Segment's Operating carrier code | IB | FlightInfoDetailed | string | OPTIONAL |
Leg_0..6_Segment_0..15_FlightNumber | Segment's Marketing carrier's flight number | 123 | FlightInfoDetailed | integer | REQUIRED |
Leg_0..6_Segment_0..15_DurationMin | Segment's duration (in minutes) | 233 | FlightInfoDetailed | integer | REQUIRED |
Leg_0..6_Segment_0..15_TravelDistanceKm |
Travel distance (great-circle distance) in km between the OriginIATA and DestinationIATA | 123 | FlightInfoDetailed | integer | REQUIRED |
Leg_0..6_DurationMin | Total leg journey duration (with flights and stopovers) in minutes | 740 | FlightInfoDetailed | integer | REQUIRED |
Comments
0 comments
Please sign in to leave a comment.