Geographic regions API - GET regions
Lists countries and their regions.
The request produces an application/json
payload.
GET | Managed | https://{your-domain}/e/{your-environment-id}/api/v2/rum/regions |
SaaS | https://{your-environment-id}.live.dynatrace.com/api/v2/rum/regions | |
Environment ActiveGate | https://{your-activegate-domain}/e/{your-environment-id}/api/v2/rum/regions |
Authentication
To execute this request, you need an access token with Read Geographic regions (geographicRegions.read
) scope. To learn how to obtain and use it, see Tokens and authentication.
Parameters
The request doesn't provide any configurable parameters.
Response
Response codes
Code | Type | Description |
---|---|---|
200 | Country | Success |
Response body objects
The CountryListWithRegions
object
An ordered list of countries with their regions
Element | Type | Description |
---|---|---|
countryCount | integer | Number of countries Can be |
countries | Country[] | An ordered list of countries. Can be |
The Country
object
The information about a country
Element | Type | Description |
---|---|---|
name | string | Country name Can be |
code | string | Country code Can be |
regions | Region[] | An ordered list of regions for a given country. Can be |
The Region
object
The information about a region for a given country
Element | Type | Description |
---|---|---|
name | string | Region name Can be |
code | string | Region code Can be |
cities | City[] | An order list of cities for a given region Can be |
The City
object
The information about a city
Element | Type | Description |
---|---|---|
name | string | City name Can be |
latitude | number | Latitude of city Can be |
longitude | number | Longitude of city Can be |
Response body JSON model
{
"countryCount": 252,
"countries": [
{
"name": "France",
"code": "FR",
"regionCount": 13,
"regions": [
{
"name": "Auvergne-Rhone-Alpes",
"code": "ARA"
},
{
"name": "Bourgogne-Franche-Comte",
"code": "BFC"
}
]
},
{
"name": "Belgium",
"code": "BE",
"regionCount": 11,
"regions": [
{
"name": "Antwerp Province",
"code": "01"
},
{
"name": "Brussels Captial",
"code": "11"
}
]
}
]
}