Geographic regions API - GET cities of a country

Lists regions and cities of a country.

The request produces an application/json payload.

GETSaaShttps://{your-environment-id}.live.dynatrace.com/api/v2/rum/cities/{countryCode}
Environment ActiveGateCluster ActiveGatehttps://{your-activegate-domain}:9999/e/{your-environment-id}/api/v2/rum/cities/{countryCode}

Authentication

To execute this request, you need an access token with geographicRegions.read scope.

To learn how to obtain and use it, see Tokens and authentication.

Parameters

Parameter
Type
Description
In
Required
countryCode
string

The ISO code of the required country.

To fetch the list of available country codes, use the GET all countries request.

path
required

Response

Response codes

Code
Type
Description
200

Success. The response contains the list of country's cities.

404

Failed. The requested resource doesn't exist.

4XX

Client side error.

5XX

Server side error.

Response body objects

The CountryWithRegionsWithCities object

Information about a country.

Element
Type
Description
countryCode
string

The ISO code of the country.

countryName
string

The name of the country.

regionCount
integer

The number of regions in the country.

regions

The list of regions in the country.

The RegionWithCities object

Information about a country's region and its cities.

Element
Type
Description
cities

The list of cities in the region.

cityCount
integer

The number of cities in a region of a country.

code
string

The code of the region.

name
string

The name of the region.

The City object

Information about a city.

Element
Type
Description
latitude
number

The latitude of the city.

longitude
number

The longitude of the city.

name
string

The name of the city.

Response body JSON model

{
  "countryCode": "FR",
  "countryName": "France",
  "regionCount": 13,
  "regions": [
    {
      "cities": [
        {
          "latitude": 46.2806,
          "longitude": 6.7217,
          "name": "Abondance"
        },
        {
          "latitude": 46.1008,
          "longitude": 3.4463,
          "name": "Abrest"
        }
      ],
      "cityCount": 4,
      "code": "ARA",
      "name": "Auvergne-Rhone-Alpes"
    }
  ]
}

Related topics