Skip to main content

routing_timeseries_groups

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

Overview

Namerouting_timeseries_groups
TypeResource
Idcloudflare.radar.routing_timeseries_groups

Fields

The following fields are returned by SELECT queries:

Successful response.

NameDatatypeDescription
metaobjectMetadata for the results.
serie_0object

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
getselectdimensionaggInterval, name, dateRange, dateStart, dateEnd, arc, dkim, dmarc, spf, ipVersion, encrypted, limitPerGroup, formatRetrieves the distribution of email routing metrics grouped by dimension over time.

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.

NameDatatypeDescription
dimensionstringSpecifies the attribute by which to group the results.
aggIntervalstringAggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to Aggregation intervals.
arcarrayFilters results by ARC (Authenticated Received Chain) validation.
dateEndarrayEnd of the date range (inclusive).
dateRangearrayFilters 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).
dateStartarrayStart of the date range.
dkimarrayFilters results by DKIM (DomainKeys Identified Mail) validation status.
dmarcarrayFilters results by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation status.
encryptedarrayFilters results by encryption status (encrypted vs. not-encrypted).
formatstringFormat in which results will be returned.
ipVersionarrayFilters results by IP version (Ipv4 vs. IPv6).
limitPerGroupintegerLimits 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.
namearrayArray of names used to label the series in the response.
spfarrayFilters results by SPF (Sender Policy Framework) validation status.

SELECT examples

Retrieves the distribution of email routing metrics grouped by dimension over time.

SELECT
meta,
serie_0
FROM cloudflare.radar.routing_timeseries_groups
WHERE dimension = '{{ dimension }}' -- required
AND aggInterval = '{{ aggInterval }}'
AND name = '{{ name }}'
AND dateRange = '{{ dateRange }}'
AND dateStart = '{{ dateStart }}'
AND dateEnd = '{{ dateEnd }}'
AND arc = '{{ arc }}'
AND dkim = '{{ dkim }}'
AND dmarc = '{{ dmarc }}'
AND spf = '{{ spf }}'
AND ipVersion = '{{ ipVersion }}'
AND encrypted = '{{ encrypted }}'
AND limitPerGroup = '{{ limitPerGroup }}'
AND format = '{{ format }}'
;