GET /radar/origins/timeseries_groups/{dimension}
Retrieves the distribution of origin metrics grouped by the specified dimension over time.
Servers
- https://api.cloudflare.com/client/v4
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
dimension |
String | Yes |
Specifies the origin attribute by which to group the results. Valid values:
|
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
metric |
String | Yes |
Specifies the metric to retrieve. Valid values:
|
region[] |
Array | No |
Filters results by origin region. |
name[] |
Array | No |
Array of names used to label the series in the response. |
format |
String | No |
Format in which results will be returned. Valid values:
|
dateEnd[] |
Array | No |
End of the date range (inclusive). |
dateStart[] |
Array | No |
Start of the date range. |
origin[] |
Array | Yes |
Filters results by origin. |
normalization |
String | No |
Normalization method applied to the results. Refer to Normalization methods. Valid values:
Default value: "PERCENTAGE" |
aggInterval |
String | No |
Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to Aggregation intervals. Valid values:
|
limitPerGroup |
Integer | No |
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. |
dateRange[] |
Array | No |
Filters results by date range. For example, use |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.