Skip to content
Site Qwality Site Qwality Site Qwality Docs

Current RUM billing usage, app claims, replay rule activity and Auto rates.

GET
/rum/{app_id}/usage
 
curl --request GET \
  --url https://api.siteqwality.com/rum/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/usage \
  --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

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Current RUM billing usage

Media type application/json
object
products
required
Array<object>
object
product
required
string
unit
required
string
period
required
string
period_start_ms
required
integer format: int64
resets_at_ms
required
integer format: int64
account_usage
required

The account’s canonical billing counter, shared by its applications.

integer format: int64
quota
required
integer format: int64
application_usage
required
integer format: int64
daily
required
Array<object>
object
date
required
string
sessions
required
integer format: int64
applications
required

Up to 100 current applications in the caller’s account, ordered by claim count.

Array<object>
object
application_id
required
string format: uuid
name
required
string
sessions
required
integer format: int64
applications_truncated
required
boolean
projected_account_usage
integer | null format: int64
projected_run_out_ms
integer | null format: int64
warning
string | null
rules
required
Array<object>
object
rule_id
required
string
name
string | null
capture
required
string
sessions
required
integer format: int64
auto_sample
boolean | null
enabled
boolean | null
effective_sample_rate
number | null format: double
rule_attribution_coverage
required

Retained session activity, not a completeness guarantee or a billing counter.

object
source
required
string
period_start_ms
required
integer format: int64
window_start_ms
required
integer format: int64
window_end_ms
required
integer format: int64
session_retention_days
required

Current lower bound for replay summary retention: max(Observe, Replay). Older rows can have different retention, and deleted data cannot be recovered.

integer format: int32
retention_limited
required

True when current retention shortens the requested billing-period window. False does not guarantee historical completeness.

boolean
rule_attribution_note
required
string
Example generated
{
  "products": [
    {
      "product": "example",
      "unit": "example",
      "period": "example",
      "period_start_ms": 1,
      "resets_at_ms": 1,
      "account_usage": 1,
      "quota": 1,
      "application_usage": 1,
      "daily": [
        {
          "date": "example",
          "sessions": 1
        }
      ],
      "applications": [
        {
          "application_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
          "name": "example",
          "sessions": 1
        }
      ],
      "applications_truncated": true,
      "projected_account_usage": 1,
      "projected_run_out_ms": 1,
      "warning": "example"
    }
  ],
  "rules": [
    {
      "rule_id": "example",
      "name": "example",
      "capture": "example",
      "sessions": 1,
      "auto_sample": true,
      "enabled": true,
      "effective_sample_rate": 1
    }
  ],
  "rule_attribution_coverage": {
    "source": "example",
    "period_start_ms": 1,
    "window_start_ms": 1,
    "window_end_ms": 1,
    "session_retention_days": 1,
    "retention_limited": true
  },
  "rule_attribution_note": "example"
}

401

Section titled “401 ”

Missing authentication

403

Section titled “403 ”

Insufficient read scope

404

Section titled “404 ”

Application not found

500

Section titled “500 ”

Internal server error