Get the top locations, by HTTP traffic, of the requested IP protocol version. Values are a percentage out of the total traffic.
/radar/http/top/locations/ip_version/{ip_version}
get
Radar Http
radar-get-http-top-locations-by-ip-version
{
"business": true,
"enterprise": true,
"free": true,
"pro": true
}{
"enum": [
"com.cloudflare.api.user.read"
]
}[
{
"in": "path",
"name": "ip_version",
"required": true,
"schema": {
"description": "IP version.",
"enum": [
"IPv4",
"IPv6"
],
"type": "string"
}
},
{
"in": "query",
"name": "limit",
"schema": {
"description": "Limit the number of objects in the response.",
"example": 5,
"type": "integer"
}
},
{
"in": "query",
"name": "name",
"schema": {
"description": "Array of names that will be used to name the series in responses.",
"example": "main_series",
"items": {
"type": "string"
},
"type": "array"
}
},
{
"in": "query",
"name": "dateRange",
"schema": {
"description": "For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).",
"items": {
"enum": [
"1d",
"2d",
"7d",
"14d",
"28d",
"12w",
"24w",
"52w",
"1dControl",
"2dControl",
"7dControl",
"14dControl",
"28dControl",
"12wControl",
"24wControl"
],
"type": "string"
},
"type": "array"
}
},
{
"in": "query",
"name": "dateStart",
"schema": {
"description": "Array of datetimes to filter the start of a series.",
"example": "2023-09-01T11:41:33.782Z",
"items": {
"format": "date-time",
"type": "string"
},
"type": "array"
}
},
{
"in": "query",
"name": "dateEnd",
"schema": {
"description": "End of the date range (inclusive).",
"example": "2023-09-01T11:41:33.782Z",
"items": {
"format": "date-time",
"type": "string"
},
"type": "array"
}
},
{
"in": "query",
"name": "asn",
"schema": {
"description": "Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.",
"example": "15169",
"items": {
"type": "string"
},
"type": "array"
}
},
{
"in": "query",
"name": "location",
"schema": {
"description": "Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.",
"example": "US,CA",
"items": {
"type": "string"
},
"type": "array"
}
},
{
"in": "query",
"name": "botClass",
"schema": {
"description": "Filter for bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).",
"example": "LIKELY_AUTOMATED",
"items": {
"enum": [
"LIKELY_AUTOMATED",
"LIKELY_HUMAN"
],
"type": "string"
},
"type": "array"
}
},
{
"in": "query",
"name": "deviceType",
"schema": {
"description": "Filter for device type.",
"example": "DESKTOP",
"items": {
"enum": [
"DESKTOP",
"MOBILE",
"OTHER"
],
"type": "string"
},
"type": "array"
}
},
{
"in": "query",
"name": "httpProtocol",
"schema": {
"description": "Filter for http protocol.",
"example": "HTTPS",
"items": {
"enum": [
"HTTP",
"HTTPS"
],
"type": "string"
},
"type": "array"
}
},
{
"in": "query",
"name": "httpVersion",
"schema": {
"description": "Filter for http version.",
"example": "HTTPv1",
"items": {
"enum": [
"HTTPv1",
"HTTPv2",
"HTTPv3"
],
"type": "string"
},
"type": "array"
}
},
{
"in": "query",
"name": "os",
"schema": {
"description": "Filter for os name.",
"example": "WINDOWS",
"items": {
"enum": [
"WINDOWS",
"MACOSX",
"IOS",
"ANDROID",
"CHROMEOS",
"LINUX",
"SMART_TV"
],
"type": "string"
},
"type": "array"
}
},
{
"in": "query",
"name": "tlsVersion",
"schema": {
"description": "Filter for tls version.",
"example": "TLSv1_2",
"items": {
"enum": [
"TLSv1_0",
"TLSv1_1",
"TLSv1_2",
"TLSv1_3",
"TLSvQUIC"
],
"type": "string"
},
"type": "array"
}
},
{
"in": "query",
"name": "format",
"schema": {
"description": "Format results are returned in.",
"enum": [
"JSON",
"CSV"
],
"example": "json",
"type": "string"
}
}
]null{
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"result": {
"properties": {
"meta": {
"properties": {
"confidenceInfo": {
"properties": {
"annotations": {
"items": {
"properties": {
"dataSource": {
"example": "ALL",
"type": "string"
},
"description": {
"example": "Cable cut in Tonga",
"type": "string"
},
"endTime": {
"format": "date-time",
"type": "string"
},
"eventType": {
"example": "OUTAGE",
"type": "string"
},
"isInstantaneous": {
"type": "object"
},
"linkedUrl": {
"type": "string"
},
"startTime": {
"format": "date-time",
"type": "string"
}
},
"required": [
"dataSource",
"eventType",
"description",
"isInstantaneous"
],
"type": "object"
},
"type": "array"
},
"level": {
"type": "integer"
}
},
"type": "object"
},
"dateRange": {
"items": {
"properties": {
"endTime": {
"description": "Adjusted end of date range.",
"example": "2022-09-17T10:22:57.555Z",
"format": "date-time",
"type": "string"
},
"startTime": {
"description": "Adjusted start of date range.",
"example": "2022-09-16T10:22:57.555Z",
"format": "date-time",
"type": "string"
}
},
"required": [
"startTime",
"endTime"
],
"type": "object"
},
"type": "array"
},
"lastUpdated": {
"example": "2023-07-26T08:59:57Z",
"type": "string"
}
},
"required": [
"dateRange",
"lastUpdated"
],
"type": "object"
},
"top_0": {
"items": {
"properties": {
"clientCountryAlpha2": {
"example": "US",
"type": "string"
},
"clientCountryName": {
"example": "United States",
"type": "string"
},
"value": {
"example": "65",
"type": "string"
}
},
"required": [
"clientCountryAlpha2",
"clientCountryName",
"value"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"meta",
"top_0"
],
"type": "object"
},
"success": {
"example": true,
"type": "boolean"
}
},
"required": [
"result",
"success"
],
"type": "object"
}
}
},
"description": "Successful Response"
},
"404": {
"content": {
"application/json": {
"schema": {
"properties": {
"error": {
"example": "Not Found",
"type": "string"
}
},
"required": [
"error"
],
"type": "object"
}
}
},
"description": "Not found"
}
}[
{
"api_email": [],
"api_key": []
}
]