Geographies

Get Metros

A Metro is a group of Cities, such as the Los Angeles area which includes LA, Hollywood, Anaheim, and more that can be used to filter Events.

Returns all Metros in Alphabetical order by identifier.

get/geographies/metros

Request

Query parameters

metroHasUpcomingEventsboolean

Only include Metros with / without upcoming events. Omit for both.

cityHasUpcomingEventsboolean

Only include Cities with / without upcoming events. Omit for both.

expandMetroCitiesboolean

Use true to include the containsPlace node with the cities for each metro.

Response

A list of Metros

successboolean

A successful response.

Example response

{
  "pagination": {
    "page": 1,
    "perPage": 10,
    "totalItems": 50,
    "totalPages": 5
  },
  "metros": [
    {
      "identifier": "jambase:13412",
      "name": "New York Area",
      "geo": {
        "latitude": 40.7505,
        "longitude": -73.9934
      },
      "address": {
        "addressRegion": "US-AZ",
        "addressCountry": "US"
      },
      "containsPlace": [
        {
          "identifier": "jambase:13412",
          "name": "New York",
          "geo": {
            "latitude": 40.7505,
            "longitude": -73.9934
          },
          "address": {
            "addressRegion": "US-AZ",
            "addressCountry": "US"
          },
          "x-timezone": "America/New_York",
          "x-numUpcomingEvents": 12
        }
      ],
      "x-primaryCityId": 12,
      "x-numUpcomingEvents": 12
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.