CLcloudflare
Radar AS112

Get AS112 summary by dimension

Changed on

Retrieves the distribution of AS112 queries by the specified dimension.

get/radar/as112/summary/{dimension}

Request

Path parameters

dimension'DNSSEC' | 'EDNS' | 'IP_VERSION' | 'PROTOCOL' | 'QUERY_TYPE' | 'RESPONSE_CODE' required

Specifies the attribute by which to group the results.

Query parameters

namestring[]

Array of names used to label the series in the response.

[
  "main_series"
]
dateRangestring[]

Filters results by relative date range ending at the current time, with each value producing a separate series. Use <n>d for days (up to 364d) or <n>w for weeks (up to 52w). Append control to request the equivalent previous period for comparison: the comparison window is shifted back by the current window's length rounded up to a whole number of weeks, so it keeps the same weekday alignment and does not overlap the current window (e.g. 7dcontrol covers days -14 to -7, 10dcontrol covers days -24 to -14). For example, pass 7d and 7dcontrol to compare this week with the previous week. All series must resolve to the same duration as the main series; relative ranges (including control) satisfy this automatically. Use this parameter or set specific start and end dates (dateStart and dateEnd parameters).

[
  "7d"
]
dateStartstring[]

Start of the date range. Alternative to dateRange; provide together with dateEnd. When requesting comparison series, every series must resolve to the same duration as the main series. Each dateStart/dateEnd is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.

dateEndstring[]

End of the date range (inclusive). Alternative to dateRange; provide together with dateStart. When requesting comparison series, every series must resolve to the same duration as the main series. Each dateStart/dateEnd is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.

locationstring[]

Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with - to exclude locations from results. For example, -US,PT excludes results from the US, but includes results from PT.

continentstring[]

Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with - to exclude continents from results. For example, -EU,NA excludes results from EU, but includes results from NA.

queryTypestring[]

Filters results by DNS query type.

protocolstring[]

Filters results by DNS transport protocol.

responseCodestring[]

Filters results by DNS response code.

limitPerGroupinteger

Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an "other" category. Only supported on high-cardinality dimensions; otherwise the request is rejected. Minimum value is 2.

Example:10
format'JSON' | 'CSV'

Format in which results will be returned.

Example:json

Response

Successful response.

successboolean required

Example response

{
  "result": {
    "meta": {
      "confidenceInfo": {
        "annotations": [
          {
            "description": "Cable cut in Tonga",
            "tags": [
              "BOT_CLASS"
            ]
          }
        ]
      },
      "dateRange": [
        {
          "endTime": "2022-09-17T10:22:57.555Z",
          "startTime": "2022-09-16T10:22:57.555Z"
        }
      ],
      "units": [
        {
          "name": "*",
          "value": "requests"
        }
      ]
    },
    "summary_0": {
      "IPv4": "50.168733",
      "IPv6": "25.084366"
    }
  },
  "success": true
}

Changes

  • 06b83c181230Revision changes
    • info

      removed the EVENT enum value from the ///// response property for the response status

  • 25657b91377cRevision changes
    • info

      added the optional property ///// to the response with the status