GET /radar/origins/summary/{dimension}

Retrieves an aggregated summary of origin metrics grouped by the specified dimension.

Servers

Path parameters

Name Type Required Description
dimension String Yes

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.

Valid values:

  • "SUCCESS_RATE"
  • "REGION"
  • "PERCENTILE"
  • "ORIGIN"

Query parameters

Name Type Required Description
metric String Yes

Specifies the metric to retrieve. Allowed metrics depend on the selected dimension (see the dimension path parameter).

Valid values:

  • "TLS_HANDSHAKE_DURATION"
  • "TCP_HANDSHAKE_DURATION"
  • "REQUESTS"
  • "RESPONSE_HEADER_RECEIVE_DURATION"
  • "CONNECTION_FAILURES"
  • "TCP_RTT"
region[] Array No

Filters results by origin region. Requires origin to be set and is validated against it.

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:

  • "CSV"
  • "JSON"
dateEnd[] Array No

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.

dateStart[] Array No

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.

origin[] Array No

Filters results by origin. Required for every dimension except ORIGIN; must not be set on the ORIGIN dimension, which groups across all providers.

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. Only supported on high-cardinality dimensions; otherwise the request is rejected. Minimum value is 2.

dateRange[] Array No

Filters results by relative date range ending at the current time, with each value producing a separate series. Use <n>d for days (up to 364d) or <n>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).

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. 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.
  3. Click Test request to test run your request to the API and see the API's response.