Skip to content
Site Qwality Site Qwality Site Qwality Docs

The values the session filters can take, with session counts: up to 50 non-empty values per list, by listed sessions active in the range and match `f`.

GET
/rum/{app_id}/facets
 
curl --request GET \
  --url https://api.siteqwality.com/rum/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/facets \
  --header 'Authorization: Bearer <token>'

Without field, browser, os, country (ISO 3166-1 alpha-2) and device_type are filled. Each list ignores the filters on its own field, so every value stays pickable; q keeps values containing it, for autocomplete.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
app_id
required
string format: uuid

RUM application identifier

Query Parameters

Section titled “Query Parameters ”
from
string

ISO 8601. Sessions active in [from, to] are counted. Default: 30 days before to.

to
string

ISO 8601. Default: now.

field
string

Comma-separated lists to fill: browser, os, country, device_type, region, release, env, route, channel, referrer_host, sdk_version. Default: the first four; lists not asked for are empty (the first four) or absent.

q
string

Case-insensitive substring the values must contain, for autocomplete.

f
Array<string>

Session filters in the RUM filter grammar, repeatable. A list ignores the filters on its own field, so every value stays pickable.

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Filter values with session counts

Media type application/json

Up to 50 non-empty values per dimension, by listed sessions active in the range.

object
browser
required
Array<object>
object
value
required
string
session_count
required
integer format: int64
os
required
Array<object>
object
value
required
string
session_count
required
integer format: int64
country
required

ISO 3166-1 alpha-2 codes.

Array<object>
object
value
required
string
session_count
required
integer format: int64
device_type
required
Array<object>
object
value
required
string
session_count
required
integer format: int64
region

Present when asked for with field.

array | null
object
value
required
string
session_count
required
integer format: int64
release
array | null
object
value
required
string
session_count
required
integer format: int64
env
array | null
object
value
required
string
session_count
required
integer format: int64
route

Sessions per visited route.

array | null
object
value
required
string
session_count
required
integer format: int64
channel
array | null
object
value
required
string
session_count
required
integer format: int64
referrer_host
array | null
object
value
required
string
session_count
required
integer format: int64
sdk_version
array | null
object
value
required
string
session_count
required
integer format: int64
Example generated
{
  "browser": [
    {
      "value": "example",
      "session_count": 1
    }
  ],
  "os": [
    {
      "value": "example",
      "session_count": 1
    }
  ],
  "country": [
    {
      "value": "example",
      "session_count": 1
    }
  ],
  "device_type": [
    {
      "value": "example",
      "session_count": 1
    }
  ],
  "region": [
    {
      "value": "example",
      "session_count": 1
    }
  ],
  "release": [
    {
      "value": "example",
      "session_count": 1
    }
  ],
  "env": [
    {
      "value": "example",
      "session_count": 1
    }
  ],
  "route": [
    {
      "value": "example",
      "session_count": 1
    }
  ],
  "channel": [
    {
      "value": "example",
      "session_count": 1
    }
  ],
  "referrer_host": [
    {
      "value": "example",
      "session_count": 1
    }
  ],
  "sdk_version": [
    {
      "value": "example",
      "session_count": 1
    }
  ]
}

400

Section titled “400 ”

Invalid query parameter

401

Section titled “401 ”

Missing or invalid authentication

403

Section titled “403 ”

A filter on console messages without body access

404

Section titled “404 ”

Application not found

500

Section titled “500 ”

Internal server error

503

Section titled “503 ”

Query time limit exceeded; narrow the range or filters