--- title: Get origin metrics distribution by dimension --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api) [Radar](https://developers.cloudflare.com/api/resources/radar) [Origins](https://developers.cloudflare.com/api/resources/radar/subresources/origins) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # Get origin metrics distribution by dimension GET/radar/origins/summary/{dimension} Retrieves an aggregated summary of origin metrics grouped by the specified dimension. ##### Security

API Token

The preferred authorization scheme for interacting with the Cloudflare API. Create a token. **Example:**Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY

API Email + API Key

The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key. **Example:**X-Auth-Email: user@example.com The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys. **Example:**X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194

##### Accepted Permissions (at least one required) `User Details Write``User Details Read` ##### P ath ParametersExpand Collapse

dimension: "ORIGIN"or "REGION"or "SUCCESS\_RATE"or "PERCENTILE" Specifies the origin attribute by which to group the results. ORIGIN groups across all providers and does not accept an origin or region. REGION requires an origin. SUCCESS_RATE and PERCENTILE require both an origin and a region and constrain the metric (SUCCESS_RATE supports only REQUESTS; PERCENTILE supports any metric except REQUESTS). limitPerGroup is only supported on the REGION dimension.

One of the following: "ORIGIN" Link to this property "REGION" Link to this property "SUCCESS\_RATE" Link to this property "PERCENTILE" Link to this property

[Link to this property](<#(resource)%20radar.origins%20%3E%20(method)%20summary%20%3E%20(params)%20default%20%3E%20(param)%20dimension%20%3E%20(schema)>) ##### Q uery ParametersExpand Collapse

metric: "CONNECTION\_FAILURES"or "REQUESTS"or "RESPONSE\_HEADER\_RECEIVE\_DURATION"or 3 more Specifies the metric to retrieve. Allowed metrics depend on the selected dimension (see the dimension path parameter).

One of the following: "CONNECTION\_FAILURES" Link to this property "REQUESTS" Link to this property "RESPONSE\_HEADER\_RECEIVE\_DURATION" Link to this property "TCP\_HANDSHAKE\_DURATION" Link to this property "TCP\_RTT" Link to this property "TLS\_HANDSHAKE\_DURATION" Link to this property

[Link to this property](<#(resource)%20radar.origins%20%3E%20(method)%20summary%20%3E%20(params)%20default%20%3E%20(param)%20metric%20%3E%20(schema)>) dateEnd: optional array of string 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. [Link to this property](<#(resource)%20radar.origins%20%3E%20(method)%20summary%20%3E%20(params)%20default%20%3E%20(param)%20dateEnd%20%3E%20(schema)>) dateRange: optional array of string Filters results by relative date range ending at the current time, with each value producing a separate series. Use `d` for days (up to `364d`) or `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). [Link to this property](<#(resource)%20radar.origins%20%3E%20(method)%20summary%20%3E%20(params)%20default%20%3E%20(param)%20dateRange%20%3E%20(schema)>) dateStart: optional array of string 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. [Link to this property](<#(resource)%20radar.origins%20%3E%20(method)%20summary%20%3E%20(params)%20default%20%3E%20(param)%20dateStart%20%3E%20(schema)>)

format: optional "JSON"or "CSV" Format in which results will be returned.

One of the following: "JSON" Link to this property "CSV" Link to this property

[Link to this property](<#(resource)%20radar.origins%20%3E%20(method)%20summary%20%3E%20(params)%20default%20%3E%20(param)%20format%20%3E%20(schema)>) limitPerGroup: optional number 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. [Link to this property](<#(resource)%20radar.origins%20%3E%20(method)%20summary%20%3E%20(params)%20default%20%3E%20(param)%20limitPerGroup%20%3E%20(schema)>) name: optional array of string Array of names used to label the series in the response. [Link to this property](<#(resource)%20radar.origins%20%3E%20(method)%20summary%20%3E%20(params)%20default%20%3E%20(param)%20name%20%3E%20(schema)>)

origin: optional array of "AMAZON"or "GOOGLE"or "MICROSOFT"or "ORACLE" Filters results by origin. Required for every dimension except ORIGIN; must not be set on the ORIGIN dimension, which groups across all providers.

One of the following: "AMAZON" Link to this property "GOOGLE" Link to this property "MICROSOFT" Link to this property "ORACLE" Link to this property

[Link to this property](<#(resource)%20radar.origins%20%3E%20(method)%20summary%20%3E%20(params)%20default%20%3E%20(param)%20origin%20%3E%20(schema)>) region: optional array of string Filters results by origin region. Requires `origin` to be set and is validated against it. [Link to this property](<#(resource)%20radar.origins%20%3E%20(method)%20summary%20%3E%20(params)%20default%20%3E%20(param)%20region%20%3E%20(schema)>) ##### ReturnsExpand Collapse

result: object {meta, summary\_0 }

meta: object {confidenceInfo, dateRange, lastUpdated, 2 more } Metadata for the results.

confidenceInfo: object {annotations, level }

annotations: array of object {dataSource, description, endDate, 5 more }

dataSource: "ALL"or "AI\_BOTS"or "AI\_GATEWAY"or 22 more Data source for annotations.

Link to this property description: string Link to this property endDate: string formatdate-time Link to this property

eventType: "GENERAL"or "OUTAGE"or "PARTIAL\_PROJECTION"or 2 more Event type for annotations.

One of the following: "GENERAL" Link to this property "OUTAGE" Link to this property "PARTIAL\_PROJECTION" Link to this property "PIPELINE" Link to this property "TRAFFIC\_ANOMALY" Link to this property

Link to this property isInstantaneous: boolean Whether event is a single point in time or a time range. Link to this property linkedUrl: string formaturi Link to this property startDate: string formatdate-time Link to this property tags: optional array of string Link to this property

Link to this property level: number Provides an indication of how much confidence Cloudflare has in the data. Link to this property

Link to this property

dateRange: array of object {endTime, startTime }

endTime: string Adjusted end of date range. formatdate-time Link to this property startTime: string Adjusted start of date range. formatdate-time Link to this property

Link to this property lastUpdated: string Timestamp of the last dataset update. formatdate-time Link to this property

normalization: "PERCENTAGE"or "MIN0\_MAX"or "MIN\_MAX"or 5 more Normalization method applied to the results. Refer to Normalization methods.

One of the following: "PERCENTAGE" Link to this property "MIN0\_MAX" Link to this property "MIN\_MAX" Link to this property "RAW\_VALUES" Link to this property "PERCENTAGE\_CHANGE" Link to this property "ROLLING\_AVERAGE" Link to this property "OVERLAPPED\_PERCENTAGE" Link to this property "RATIO" Link to this property

Link to this property

units: array of object {name, value } Measurement units for the results.

name: string Link to this property value: string Link to this property

Link to this property

Link to this property summary\_0: map\[string] Link to this property

[Link to this property](<#(resource)%20radar.origins%20%3E%20(method)%20summary%20%3E%20(network%20schema)%20%3E%20(property)%20result>) success: boolean [Link to this property](<#(resource)%20radar.origins%20%3E%20(method)%20summary%20%3E%20(network%20schema)%20%3E%20(property)%20success>) ### Get origin metrics distribution by dimension HTTP HTTPTypeScriptPythonGoTerraform ``` curl https://api.cloudflare.com/client/v4/radar/origins/summary/$DIMENSION \ -H "Authorization: Bearer $CLOUDFLARE_API_TOKEN" ``` 200 example ``` { "result": { "meta": { "confidenceInfo": { "annotations": [ { "dataSource": "ALL", "description": "Cable cut in Tonga", "endDate": "2019-12-27T18:11:19.117Z", "eventType": "GENERAL", "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": { "eu-west-1": "52.14", "us-east-1": "45.23", "us-west-2": "38.67" } }, "success": true } ``` ##### Returns Examples 200 example ``` { "result": { "meta": { "confidenceInfo": { "annotations": [ { "dataSource": "ALL", "description": "Cable cut in Tonga", "endDate": "2019-12-27T18:11:19.117Z", "eventType": "GENERAL", "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": { "eu-west-1": "52.14", "us-east-1": "45.23", "us-west-2": "38.67" } }, "success": true } ```