{
  "swagger": "2.0",
  "info": {
    "version": "1.1.1",
    "title": "Flight Most Traveled Destinations",
    "x-tags": [
      "#ama-for-dev"
    ],
    "x-status": "validated",
    "x-release-note": {
      "1.1.0": [
        "AFD-1091 - change from \"traveller\" to \"traveler\"",
        "Correct example",
        "Naming of parameter origin changed for originCityCode"
      ],
      "1.0.3": [
        "AFD-953 - change score format"
      ],
      "1.0.2": [
        "AFD-743 - add subtype in the reply"
      ],
      "1.0.1": [
        "replace \"flight\" and \"traveller\" values by score"
      ],
      "1.0.0": [
        "Initial Version"
      ]
    },
    "description": "\nBefore using this API, we recommend you read our **[Authorization Guide](https://developers.amadeus.com/self-service/apis-docs/guides/authorization-262)** for more information on how to generate an access token.\n\nPlease also be aware that our test environment is based on a subset of the production, this API in test only returns a few selected cities. You can find the list in our **[data collection](https://github.com/amadeus4dev/data-collection)**."
  },
  "host": "test.api.amadeus.com",
  "basePath": "/v1",
  "schemes": [
    "https"
  ],
  "consumes": [
    "application/vnd.amadeus+json"
  ],
  "produces": [
    "application/vnd.amadeus+json"
  ],
  "paths": {
    "/travel/analytics/air-traffic/traveled": {
      "get": {
        "tags": [
          "air-traffic"
        ],
        "operationId": "getAirTraffic",
        "summary": "Returns a list of air traffic reports.",
        "parameters": [
          {
            "name": "originCityCode",
            "description": "Code for the origin city following IATA standard ([IATA table codes](http://www.iata.org/publications/Pages/code-search.aspx)). - e.g. BOS for Boston",
            "in": "query",
            "required": true,
            "type": "string",
            "pattern": "[A-Za-z]{3}",
            "x-example": "MAD"
          },
          {
            "name": "period",
            "description": "period when consumers are traveling.\n* It can be a month only. \n* [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format must be used - e.g. 2015-05. \n* Period ranges are not supported. \n* Only periods from 2011-01 up to previous month are valid. \n* Future dates are not supported.\n",
            "in": "query",
            "required": true,
            "type": "string",
            "x-example": "2017-01"
          },
          {
            "name": "max",
            "description": "maximum number of destinations in the response. Default value is **10** and maximum value is 50.",
            "in": "query",
            "required": false,
            "default": 10,
            "type": "number",
            "format": "integer"
          },
          {
            "$ref": "#/parameters/fields"
          },
          {
            "$ref": "#/parameters/pageLimit"
          },
          {
            "$ref": "#/parameters/pageOffset"
          },
          {
            "$ref": "#/parameters/sort"
          }
        ],
        "responses": {
          "200": {
            "$ref": "#/responses/air-traffic"
          },
          "400": {
            "$ref": "#/responses/400"
          },
          "default": {
            "$ref": "#/responses/500"
          }
        },
        "description": ""
      }
    }
  },
  "parameters": {
    "pageLimit": {
      "name": "page[limit]",
      "description": "maximum items in one page",
      "required": false,
      "in": "query",
      "type": "integer",
      "default": 10
    },
    "pageOffset": {
      "name": "page[offset]",
      "description": "start index of the requested page",
      "required": false,
      "in": "query",
      "type": "integer",
      "default": 0
    },
    "sort": {
      "description": "defines on which attribute the sorting will be done:\n* **analytics.flights.score** - sort destination by flights score (decreasing)\n* **analytics.travelers.score** - sort destination by traveler's score (decreasing)\n",
      "name": "sort",
      "required": false,
      "in": "query",
      "type": "string",
      "default": "analytics.travelers.score",
      "enum": [
        "analytics.flights.score",
        "analytics.travelers.score"
      ]
    },
    "fields": {
      "name": "fields",
      "required": false,
      "in": "query",
      "type": "string",
      "description": "list of attributes desired in the response or list of attributes to remove from the response (with \"-\" before fields) \n* The attributes names must contain the whole path (except resource name) e.g. travelers"
    }
  },
  "definitions": {
    "Air_Traffic": {
      "properties": {
        "type": {
          "type": "string",
          "example": "air-traffic"
        },
        "subType": {
          "type": "string"
        },
        "destination": {
          "description": "IATA code of the destination city - [IATA table codes](http://www.iata.org/publications/Pages/code-search.aspx)",
          "type": "string",
          "example": "WAS"
        },
        "analytics": {
          "$ref": "#/definitions/Analytics"
        }
      }
    },
    "Error_400": {
      "properties": {
        "errors": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/Issue"
          }
        }
      },
      "required": [
        "errors"
      ],
      "example": {
        "errors": [
          {
            "status": 400,
            "code": 477,
            "title": "INVALID FORMAT",
            "detail": "invalid query parameter format",
            "source": {
              "parameter": "airport",
              "example": "CDG"
            }
          }
        ]
      }
    },
    "Error_500": {
      "properties": {
        "errors": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/Issue"
          }
        }
      },
      "required": [
        "errors"
      ],
      "example": {
        "errors": [
          {
            "status": 500,
            "code": 141,
            "title": "SYSTEM ERROR HAS OCCURRED"
          }
        ]
      }
    },
    "Issue": {
      "properties": {
        "status": {
          "description": "the HTTP status code applicable to this error",
          "type": "integer"
        },
        "code": {
          "description": "an application-specific error code",
          "type": "integer",
          "format": "int64"
        },
        "title": {
          "description": "a short summary of the error",
          "type": "string"
        },
        "detail": {
          "description": "explanation of the error",
          "type": "string"
        },
        "source": {
          "type": "object",
          "title": "Issue_Source",
          "description": "an object containing references to the source of the error",
          "maxProperties": 1,
          "properties": {
            "pointer": {
              "description": "a JSON Pointer [RFC6901] to the associated entity in the request document",
              "type": "string"
            },
            "parameter": {
              "description": "a string indicating which URI query parameter caused the issue",
              "type": "string"
            },
            "example": {
              "description": "a string indicating an example of the right value",
              "type": "string"
            }
          }
        }
      }
    },
    "Collection_Meta": {
      "title": "Collection_Meta",
      "properties": {
        "count": {
          "type": "integer",
          "example": 1
        },
        "links": {
          "title": "CollectionLinks",
          "properties": {
            "self": {
              "type": "string",
              "format": "uri",
              "example": "https://test.api.amadeus.com/v1/area/resources?..."
            },
            "next": {
              "type": "string",
              "format": "uri",
              "example": "https://test.api.amadeus.com/v1/area/resources?..."
            },
            "previous": {
              "type": "string",
              "format": "uri",
              "example": "https://test.api.amadeus.com/v1/area/resources?..."
            },
            "last": {
              "type": "string",
              "format": "uri",
              "example": "https://test.api.amadeus.com/v1/area/resources?..."
            },
            "first": {
              "type": "string",
              "format": "uri",
              "example": "https://test.api.amadeus.com/v1/area/resources?..."
            },
            "up": {
              "type": "string",
              "format": "uri",
              "example": "https://test.api.amadeus.com/v1/area/resources?..."
            }
          },
          "example": {
            "self": "https://test.api.amadeus.com/v1/area/resources?param=value"
          }
        }
      }
    },
    "Analytics": {
      "properties": {
        "flights": {
          "$ref": "#/definitions/Flights"
        },
        "travelers": {
          "$ref": "#/definitions/Travelers"
        }
      }
    },
    "Flights": {
      "properties": {
        "score": {
          "type": "number",
          "format": "integer",
          "description": "Approximate score for ranking purposes calculated based on number of flights from / to the airport or city",
          "example": 56
        }
      }
    },
    "Travelers": {
      "properties": {
        "score": {
          "type": "number",
          "format": "integer",
          "description": "Approximate score for ranking purposes calculated based on number of travelers in the location.",
          "example": 68
        }
      }
    }
  },
  "responses": {
    "400": {
      "description": "code    | title                                 \n------- | ------------------------------------- \n477     | INVALID FORMAT\n572     | INVALID OPTION\n2781    | INVALID LENGTH\n4926    | INVALID DATA RECEIVED                               \n32171   | MANDATORY DATA MISSING \t     \n",
      "schema": {
        "$ref": "#/definitions/Error_400"
      }
    },
    "500": {
      "description": "Unexpected Error",
      "schema": {
        "$ref": "#/definitions/Error_500"
      }
    },
    "air-traffic": {
      "description": "Successful Operation",
      "schema": {
        "title": "Success",
        "required": [
          "data"
        ],
        "properties": {
          "warnings": {
            "type": "array",
            "items": {
              "$ref": "#/definitions/Issue"
            }
          },
          "meta": {
            "$ref": "#/definitions/Collection_Meta"
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/definitions/Air_Traffic"
            }
          }
        },
        "example": {
          "meta": {
            "count": 10,
            "links": {
              "self": "https://test.api.amadeus.com/v1/travel/analytics/air-traffic/traveled?max=10&originCityCode=MAD&page%5Blimit%5D=10&page%5Boffset%5D=0&period=2017-01&sort=analytics.travelers.score"
            }
          },
          "data": [
            {
              "type": "air-traffic",
              "destination": "PAR",
              "subType": "TRAVELED",
              "analytics": {
                "flights": {
                  "score": 74
                },
                "travelers": {
                  "score": 100
                }
              }
            },
            {
              "type": "air-traffic",
              "destination": "BCN",
              "subType": "TRAVELED",
              "analytics": {
                "flights": {
                  "score": 100
                },
                "travelers": {
                  "score": 78
                }
              }
            },
            {
              "type": "air-traffic",
              "destination": "TCI",
              "subType": "TRAVELED",
              "analytics": {
                "flights": {
                  "score": 33
                },
                "travelers": {
                  "score": 67
                }
              }
            },
            {
              "type": "air-traffic",
              "destination": "LON",
              "subType": "TRAVELED",
              "analytics": {
                "flights": {
                  "score": 71
                },
                "travelers": {
                  "score": 56
                }
              }
            },
            {
              "type": "air-traffic",
              "destination": "BRU",
              "subType": "TRAVELED",
              "analytics": {
                "flights": {
                  "score": 23
                },
                "travelers": {
                  "score": 38
                }
              }
            },
            {
              "type": "air-traffic",
              "destination": "NYC",
              "subType": "TRAVELED",
              "analytics": {
                "flights": {
                  "score": 43
                },
                "travelers": {
                  "score": 22
                }
              }
            },
            {
              "type": "air-traffic",
              "destination": "UIO",
              "subType": "TRAVELED",
              "analytics": {
                "flights": {
                  "score": 38
                },
                "travelers": {
                  "score": 15
                }
              }
            },
            {
              "type": "air-traffic",
              "destination": "SDQ",
              "subType": "TRAVELED",
              "analytics": {
                "flights": {
                  "score": 10
                },
                "travelers": {
                  "score": 15
                }
              }
            },
            {
              "type": "air-traffic",
              "destination": "OPO",
              "subType": "TRAVELED",
              "analytics": {
                "flights": {
                  "score": 16
                },
                "travelers": {
                  "score": 8
                }
              }
            },
            {
              "type": "air-traffic",
              "destination": "DXB",
              "subType": "TRAVELED",
              "analytics": {
                "flights": {
                  "score": 26
                },
                "travelers": {
                  "score": 7
                }
              }
            }
          ]
        }
      }
    }
  },
  "x-generatedAt": "2020-07-30T09:26:58.209Z"
}