Skip to content
Site Qwality Site Qwality Site Qwality Docs

get_rum_overview

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

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

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

Query Parameters

Section titled “Query Parameters ”
from
string
to
string
f
Array<string>
country
string
browser
string
os
string
device_type
string
url
string
device_class
string

desktop, mobile (phone and tablet), or all.

compare
string

previous returns the immediately preceding, non-overlapping period.

interval
string
tz
string
metric
string

Timeseries: sessions, views, errors, sessions_with_errors_pct. Attribution: lcp, inp, cls.

vital
string
route
string
group_by
string

route (default) or path.

limit
integer format: int32
offset
integer format: int32

Responses

Section titled “ Responses ”

200

Section titled “200 ”

OK

Media type application/json
object
session_count
required

Sessions with a page view in the range; approximate (within about 1%) above a few thousand.

integer format: int64
error_count
required

Error events in the range.

integer format: int64
error_rate
required

Error events per session.

number format: double
avg_lcp_ms
required

Deprecated: mean of one value per page view. Use p75_lcp_ms.

number format: double
avg_fcp_ms
required

Deprecated: mean of one value per page view. Use p75_fcp_ms.

number format: double
avg_cls
required

Deprecated: mean of one value per page view. Use p75_cls.

number format: double
avg_inp_ms
required

Deprecated: mean of one value per page view. Use p75_inp_ms.

number format: double
avg_ttfb_ms
required

Deprecated: mean of one value per page view. Use p75_ttfb_ms.

number format: double
top_pages
required
Array<object>
object
url
required

The page URL; the route (such as /products/:id) when the Overview is approximate.

string
view_count
required
integer format: int64
avg_lcp_ms
required

Deprecated: mean of one value per page view. Use p75_lcp_ms.

number format: double
avg_load_time_ms
required

Deprecated: mean of one value per initial page load. Use p75_load_time_ms.

number format: double
p75_lcp_ms
number | null format: double
p75_inp_ms
number | null format: double
p75_cls
number | null format: double
p75_load_time_ms

Initial page loads only; route changes carry no load time.

number | null format: double
vitals_samples
required

Page views with at least one of LCP, INP or CLS.

integer format: int64
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
view_count
required

Page views in the range.

integer format: int64
error_session_count
required

Sessions counted in session_count with at least one error event in the range.

integer format: int64
error_session_rate
required

error_session_count over session_count, from 0 to 1.

number format: double
p75_lcp_ms

75th percentile over one value per page view; null without samples.

number | null format: double
p75_inp_ms
number | null format: double
p75_cls
number | null format: double
p75_fcp_ms
number | null format: double
p75_ttfb_ms
number | null format: double
vitals_distribution
required

Page views per Web Vital, split by Google’s good / needs improvement / poor thresholds.

object
lcp
required
object
samples
required

Page views with a valid value.

integer format: int64
good
required
integer format: int64
needs_improvement
required
integer format: int64
poor
required
integer format: int64
inp
required
object
samples
required

Page views with a valid value.

integer format: int64
good
required
integer format: int64
needs_improvement
required
integer format: int64
poor
required
integer format: int64
cls
required
object
samples
required

Page views with a valid value.

integer format: int64
good
required
integer format: int64
needs_improvement
required
integer format: int64
poor
required
integer format: int64
fcp
required
object
samples
required

Page views with a valid value.

integer format: int64
good
required
integer format: int64
needs_improvement
required
integer format: int64
poor
required
integer format: int64
ttfb
required
object
samples
required

Page views with a valid value.

integer format: int64
good
required
integer format: int64
needs_improvement
required
integer format: int64
poor
required
integer format: int64
vitals_sample_rate
required

Share of page views the vitals, distribution and top page vitals were computed from: 1 below 400,000 views in the range, else a uniform sample with counts scaled back.

number format: double
session_query
required

Pass verbatim to the Sessions list to preserve view-cohort membership.

string
visitor_count
required
integer format: int64
bounce_rate
required

Fraction from 0 to 1. One-view sessions with under 10 seconds active time.

number format: double
median_active_ms
number | null format: double
approximate
required

True when these numbers come from the daily rollup (large applications, windows of at least 3 days, filters on device class, device, browser, OS or country only). The window then starts at the UTC midnight nearest from (session_query and previous follow it), a window ending within 20 minutes of now counts today up to the last 15-minute refresh, sessions and visitors are estimates (about 1%), page and session metrics use each view’s latest sample within its UTC day, and top_pages[].url holds routes.

boolean
previous

The same fields for the preceding window, without its own previous. Typed as an object so the spec has no self-reference for docs renderers.

object | null
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,
      "p75_lcp_ms": 1,
      "p75_inp_ms": 1,
      "p75_cls": 1,
      "p75_load_time_ms": 1,
      "vitals_samples": 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
    }
  ],
  "view_count": 1,
  "error_session_count": 1,
  "error_session_rate": 1,
  "p75_lcp_ms": 1,
  "p75_inp_ms": 1,
  "p75_cls": 1,
  "p75_fcp_ms": 1,
  "p75_ttfb_ms": 1,
  "vitals_distribution": {
    "lcp": {
      "samples": 1,
      "good": 1,
      "needs_improvement": 1,
      "poor": 1
    },
    "inp": {
      "samples": 1,
      "good": 1,
      "needs_improvement": 1,
      "poor": 1
    },
    "cls": {
      "samples": 1,
      "good": 1,
      "needs_improvement": 1,
      "poor": 1
    },
    "fcp": {
      "samples": 1,
      "good": 1,
      "needs_improvement": 1,
      "poor": 1
    },
    "ttfb": {
      "samples": 1,
      "good": 1,
      "needs_improvement": 1,
      "poor": 1
    }
  },
  "vitals_sample_rate": 1,
  "session_query": "example",
  "visitor_count": 1,
  "bounce_rate": 1,
  "median_active_ms": 1,
  "approximate": true,
  "previous": "example"
}

400

Section titled “400 ”

Invalid analytics query

404

Section titled “404 ”

Application not found

503

Section titled “503 ”

Query time limit exceeded

Privacy Cookie preferences