Skip to content
SiteQwality SiteQwality Docs

Get RUM overview metrics for an application within a time window.

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

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
required
string

RFC3339 lower bound

to
required
string

RFC3339 upper bound

country
string

Filter by country

browser
string

Filter by browser

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Overview metrics

Media type application/json
object
session_count
required
integer format: int64
error_count
required
integer format: int64
error_rate
required
number format: double
avg_lcp_ms
required
number format: double
avg_fcp_ms
required
number format: double
avg_cls
required
number format: double
avg_inp_ms
required
number format: double
avg_ttfb_ms
required
number format: double
top_pages
required
Array<object>
object
url
required
string
view_count
required
integer format: int64
avg_lcp_ms
required
number format: double
avg_load_time_ms
required
number format: double
top_errors
required
Array<object>
object
error_fingerprint
required
string
error_message
required
string
count
required
integer format: int64
country_breakdown
required
Array<object>
object
country
required
string
session_count
required
integer format: int64
browser_breakdown
required
Array<object>
object
browser
required
string
session_count
required
integer format: int64
Example generated
{
  "session_count": 1,
  "error_count": 1,
  "error_rate": 1,
  "avg_lcp_ms": 1,
  "avg_fcp_ms": 1,
  "avg_cls": 1,
  "avg_inp_ms": 1,
  "avg_ttfb_ms": 1,
  "top_pages": [
    {
      "url": "example",
      "view_count": 1,
      "avg_lcp_ms": 1,
      "avg_load_time_ms": 1
    }
  ],
  "top_errors": [
    {
      "error_fingerprint": "example",
      "error_message": "example",
      "count": 1
    }
  ],
  "country_breakdown": [
    {
      "country": "example",
      "session_count": 1
    }
  ],
  "browser_breakdown": [
    {
      "browser": "example",
      "session_count": 1
    }
  ]
}

401

Section titled “401 ”

Missing or invalid authentication

500

Section titled “500 ”

Internal server error