Skip to main content
POST
/
api
/
analytics.extremes
Get min/max extremes of a metric across grouped data
curl --request POST \
  --url https://your-instance.example.com/api/analytics.extremes \
  --header 'Content-Type: application/json' \
  --data '
{
  "workspace_id": "<string>",
  "metric": "<string>",
  "groupBy": [
    "<string>"
  ],
  "dateRange": {
    "start": "<string>",
    "end": "<string>",
    "preset": "previous_30_minutes",
    "granularity": "hour"
  },
  "filters": [
    {
      "dimension": "<string>",
      "operator": "equals",
      "values": [
        {}
      ]
    }
  ],
  "metricFilters": [
    {
      "metric": "<string>",
      "operator": "gt",
      "values": [
        {}
      ]
    }
  ],
  "timezone": "<string>",
  "havingMinSessions": 2,
  "table": "sessions"
}
'
{}

Body

application/json
workspace_id
string
required
metric
string
required
groupBy
string[]
required
Minimum array length: 1
dateRange
object
required
filters
object[]
metricFilters
object[]
timezone
string
havingMinSessions
number
Required range: x >= 1
table
enum<string>
Available options:
sessions,
pages,
goals

Response

200 - application/json

The response is of type object.