Get top locations by IP version

Get the top locations, by HTTP traffic, of the requested IP protocol version. Values are a percentage out of the total traffic.

Request

Path Params

ip_version

string

required

IP version.

Query Params

limit

integer

optional

Limit the number of objects in the response.

name

array[string]

optional

Array of names that will be used to name the series in responses.

dateRange

array[string]

optional

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).

dateStart

array[string]

optional

Array of datetimes to filter the start of a series.

dateEnd

array[string]

optional

Array of datetimes to filter the end of a series.

asn

array[string]

optional

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.

location

array[string]

optional

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.

botClass

array[string]

optional

Filter for bot class. Refer to Bot classes.

deviceType

array[string]

optional

Filter for device type.

format

string

optional

Format results are returned in.

Responses

🟢200Successful Response

application/json

Body

result

object

required

meta

object

required

top_0

array [object {3}]

required

success

boolean

required

Example:

true

Example

{
  "result": {
    "meta": {
      "confidenceInfo": {
        "annotations": [
          {
            "dataSource": "string",
            "description": "string",
            "endTime": "2022-09-15T00:00:00Z",
            "eventType": "string",
            "startTime": "2022-09-15T00:00:00Z"
          }
        ],
        "level": 0
      },
      "dateRange": {
        "endTime": "2022-09-15T00:00:00Z",
        "startTime": "2022-09-15T00:00:00Z"
      }
    },
    "top_0": [
      {
        "clientCountryAlpha2": "US",
        "clientCountryName": "United States",
        "value": "65"
      }
    ]
  },
  "success": true
}

🟠404Not found

Get top locations by IP version

Request

Request samples

Responses