Get DNS summary by dimension
Retrieves the distribution of DNS queries by the specified dimension.
Security
API Token
The preferred authorization scheme for interacting with the Cloudflare API. Create a token.
Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYYAPI Email + API Key
The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.
X-Auth-Email: user@example.comThe previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.
X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194Accepted Permissions (at least one required)
User Details WriteUser Details ReadParametersExpand Collapse
dimension DNSSummaryV2ParamsDimensionSpecifies the attribute by which to group the results. Grouping by TLD_DNS_MAGNITUDE does not support sub-daily aggregation intervals; 15m and 1h are raised to 1d.
Specifies the attribute by which to group the results. Grouping by TLD_DNS_MAGNITUDE does not support sub-daily aggregation intervals; 15m and 1h are raised to 1d.
query DNSSummaryV2Params
Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with - to exclude ASNs from results. For example, -174, 3356 excludes results from AS174, but includes results from AS3356.
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.
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.
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).
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.
DNSSEC param.Field[[]DNSSummaryV2ParamsDNSSEC]OptionalFilters results based on DNSSEC (DNS Security Extensions) support.
Filters results based on DNSSEC (DNS Security Extensions) support.
DNSSECAware param.Field[[]DNSSummaryV2ParamsDNSSECAware]OptionalFilters results based on DNSSEC (DNS Security Extensions) client awareness.
Filters results based on DNSSEC (DNS Security Extensions) client awareness.
Filters results based on DNSSEC-validated answers by end-to-end security status.
IPVersion param.Field[[]DNSSummaryV2ParamsIPVersion]OptionalFilters results by IP version (Ipv4 vs. IPv6).
Filters results by IP version (Ipv4 vs. IPv6).
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.
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.
Filters results based on whether the queries have a matching answer.
Specifies whether the response includes empty DNS responses (NODATA).
Protocol param.Field[[]DNSSummaryV2ParamsProtocol]OptionalFilters results by DNS transport protocol.
Filters results by DNS transport protocol.
ResponseCode param.Field[[]DNSSummaryV2ParamsResponseCode]OptionalFilters results by DNS response code.
Filters results by DNS response code.
ReturnsExpand Collapse
type DNSSummaryV2Response struct{…}
Meta DNSSummaryV2ResponseMetaMetadata for the results.
Metadata for the results.
ConfidenceInfo DNSSummaryV2ResponseMetaConfidenceInfo
Annotations []DNSSummaryV2ResponseMetaConfidenceInfoAnnotation
DataSource DNSSummaryV2ResponseMetaConfidenceInfoAnnotationsDataSourceData source for annotations.
Data source for annotations.
EventType DNSSummaryV2ResponseMetaConfidenceInfoAnnotationsEventTypeEvent type for annotations.
Event type for annotations.
Normalization DNSSummaryV2ResponseMetaNormalizationNormalization method applied to the results. Refer to Normalization methods.
Normalization method applied to the results. Refer to Normalization methods.
Get DNS summary by dimension
package main
import (
"context"
"fmt"
"github.com/cloudflare/cloudflare-go"
"github.com/cloudflare/cloudflare-go/option"
"github.com/cloudflare/cloudflare-go/radar"
)
func main() {
client := cloudflare.NewClient(
option.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"),
)
response, err := client.Radar.DNS.SummaryV2(
context.TODO(),
radar.DNSSummaryV2ParamsDimensionAs,
radar.DNSSummaryV2Params{
},
)
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", response.Meta)
}
{
"result": {
"meta": {
"confidenceInfo": {
"annotations": [
{
"dataSource": "ALL",
"description": "Cable cut in Tonga",
"endDate": "2019-12-27T18:11:19.117Z",
"eventType": "EVENT",
"isInstantaneous": true,
"linkedUrl": "https://example.com",
"startDate": "2019-12-27T18:11:19.117Z",
"tags": [
"BOT_CLASS"
]
}
],
"level": 0
},
"dateRange": [
{
"endTime": "2022-09-17T10:22:57.555Z",
"startTime": "2022-09-16T10:22:57.555Z"
}
],
"lastUpdated": "2019-12-27T18:11:19.117Z",
"normalization": "PERCENTAGE",
"units": [
{
"name": "*",
"value": "requests"
}
]
},
"summary_0": {
"IPv4": "50.168733",
"IPv6": "25.084366"
}
},
"success": true
}Returns Examples
{
"result": {
"meta": {
"confidenceInfo": {
"annotations": [
{
"dataSource": "ALL",
"description": "Cable cut in Tonga",
"endDate": "2019-12-27T18:11:19.117Z",
"eventType": "EVENT",
"isInstantaneous": true,
"linkedUrl": "https://example.com",
"startDate": "2019-12-27T18:11:19.117Z",
"tags": [
"BOT_CLASS"
]
}
],
"level": 0
},
"dateRange": [
{
"endTime": "2022-09-17T10:22:57.555Z",
"startTime": "2022-09-16T10:22:57.555Z"
}
],
"lastUpdated": "2019-12-27T18:11:19.117Z",
"normalization": "PERCENTAGE",
"units": [
{
"name": "*",
"value": "requests"
}
]
},
"summary_0": {
"IPv4": "50.168733",
"IPv6": "25.084366"
}
},
"success": true
}