Skip to main content

origins_timeseries_groups

Creates, updates, deletes, gets or lists an origins_timeseries_groups resource.

Overview

Nameorigins_timeseries_groups
TypeResource
Idcloudflare.radar.origins_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, limitPerGroup, origin, metric, region, normalization, formatRetrieves the distribution of origin metrics grouped by the specified 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 origin 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.
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.
formatstringFormat in which results will be returned.
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.
metricstringSpecifies the metric to retrieve.
namearrayArray of names used to label the series in the response.
normalizationstringNormalization method applied to the results. Refer to Normalization methods.
originarrayFilters results by origin. Required for all dimensions except ORIGIN.
regionarrayFilters results by origin region.

SELECT examples

Retrieves the distribution of origin metrics grouped by the specified dimension over time.

SELECT
meta,
serie_0
FROM cloudflare.radar.origins_timeseries_groups
WHERE dimension = '{{ dimension }}' -- required
AND aggInterval = '{{ aggInterval }}'
AND name = '{{ name }}'
AND dateRange = '{{ dateRange }}'
AND dateStart = '{{ dateStart }}'
AND dateEnd = '{{ dateEnd }}'
AND limitPerGroup = '{{ limitPerGroup }}'
AND origin = '{{ origin }}'
AND metric = '{{ metric }}'
AND region = '{{ region }}'
AND normalization = '{{ normalization }}'
AND format = '{{ format }}'
;