Geographic regions API - GET regions of a country
Lists regions of a country.
The request produces an application/json
payload.
GET | SaaS | https://{your-environment-id}.live.dynatrace.com/api/v2/rum/regions/{countryCode} |
Environment ActiveGateCluster ActiveGate | https://{your-activegate-domain}:9999/e/{your-environment-id}/api/v2/rum/regions/{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 | Country | Success. The response contains the list of country's regions. |
404 | Error | Failed. The requested resource doesn't exist. |
4XX | Error | Client side error. |
5XX | Error | Server side error. |
Response body objects
The CountryWithRegions
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 | Region[] | 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
{"countryCode": "FR","countyName": "France","regionCount": 2,"regions": [{"code": "ARA","name": "Auvergne-Rhone-Alpes"},{"code": "BFC","name": "Bourgogne-Franche-Comte"}]}