netflows_summary

Creates, updates, deletes, gets or lists a netflows_summary resource.

Overview

Name	netflows_summary
Type	Resource
Id	cloudflare.radar.netflows_summary

Fields

The following fields are returned by SELECT queries:

get

Successful response.

Name	Datatype	Description
meta	object	Metadata for the results.
summary_0	object

list

Successful response.

Name	Datatype	Description
meta	object	Metadata for the results.
summary_0	object

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	dimension	name, dateRange, dateStart, dateEnd, asn, location, continent, geoId, product, limitPerGroup, format	Retrieves the distribution of network traffic (NetFlows) by the specified dimension.
list	select		name, dateRange, dateStart, dateEnd, asn, location, continent, geoId, format	Retrieves the distribution of network traffic (NetFlows) by HTTP vs other protocols.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
dimension	string	Specifies the NetFlows attribute by which to group the results.
asn	array	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.
continent	array	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.
dateEnd	array	End of the date range (inclusive).
dateRange	array	Filters results by date range. 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	Start of the date range.
format	string	Format in which results will be returned.
geoId	array	Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with - to exclude geoIds from results. For example, -2267056,360689 excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York).
limitPerGroup	integer	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.
location	array	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.
name	array	Array of names used to label the series in the response.
product	array	Filters the results by network traffic product types.

SELECT examples

get

Retrieves the distribution of network traffic (NetFlows) by the specified dimension.

SELECT
meta,
summary_0
FROM cloudflare.radar.netflows_summary
WHERE dimension = '{{ dimension }}' -- required
AND name = '{{ name }}'
AND dateRange = '{{ dateRange }}'
AND dateStart = '{{ dateStart }}'
AND dateEnd = '{{ dateEnd }}'
AND asn = '{{ asn }}'
AND location = '{{ location }}'
AND continent = '{{ continent }}'
AND geoId = '{{ geoId }}'
AND product = '{{ product }}'
AND limitPerGroup = '{{ limitPerGroup }}'
AND format = '{{ format }}'
;

list

Retrieves the distribution of network traffic (NetFlows) by HTTP vs other protocols.

SELECT
meta,
summary_0
FROM cloudflare.radar.netflows_summary
WHERE name = '{{ name }}'
AND dateRange = '{{ dateRange }}'
AND dateStart = '{{ dateStart }}'
AND dateEnd = '{{ dateEnd }}'
AND asn = '{{ asn }}'
AND location = '{{ location }}'
AND continent = '{{ continent }}'
AND geoId = '{{ geoId }}'
AND format = '{{ format }}'
;