Geographic regions API - GET regions

Lists countries and their regions.

The request produces an application/json payload.

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

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

The request doesn't provide any configurable parameters.

Response

Response codes

Code
Type
Description
200

Success. The response contains the list of countries with regional divisions.

4XX

Client side error.

5XX

Server side error.

Response body objects

The CountryListWithRegions object

A list of countries with their regions.

Element
Type
Description
countries

The list of countries.

countryCount
integer

The number of countries.

The CountryRegions object

Information about a country.

Element
Type
Description
code
string

The ISO code of the country.

name
string

The name of the country.

regionCount
integer

The number of regions in the country.

regions

The list of regions in the country.

The Region object

Information about a country's region.

Element
Type
Description
code
string

The code of the region.

name
string

The name of the region.

Response body JSON model

{
  "countries": [
    {
      "code": "FR",
      "name": "France",
      "regionCount": 2,
      "regions": [
        {
          "code": "ARA",
          "name": "Auvergne-Rhone-Alpes"
        },
        {
          "code": "BFC",
          "name": "Bourgogne-Franche-Comte"
        }
      ]
    },
    {
      "code": "BE",
      "name": "Belgium",
      "regionCount": 2,
      "regions": [
        {
          "code": "01",
          "name": "Antwerp Province"
        },
        {
          "code": "11",
          "name": "Brussels Captial"
        }
      ]
    }
  ],
  "countryCount": 252
}

Related topics