Real-user data (RUM)

Base URL: https://webvyze.com/api/v1 · click an endpoint for its scope, parameters, example and responses.

GET/sites/{site}/widgetReal-user Core Web Vitals (p75)

Needs access to the site, when there is one.

Scope: api:read
Path parameters: {site} integer
Responses: 200401402403422429

curl -H "Authorization: Bearer $WEBVYZE_KEY" \
  https://webvyze.com/api/v1/sites/{site}/widget

Link to this endpoint

GET/sites/{site}/widget/actionsWhat to do now: actions ordered by impact, from the last 7 days

Needs access to the site, when there is one.

Scope: api:read
Path parameters: {site} integer
Responses: 200401402403422429

curl -H "Authorization: Bearer $WEBVYZE_KEY" \
  https://webvyze.com/api/v1/sites/{site}/widget/actions

Link to this endpoint

GET/sites/{site}/widget/budgetsPerformance budgets (GET) or set them (PUT)

Needs the sites.manage permission in the account.

Scope: api:read
Path parameters: {site} integer
Responses: 200401402403422429

curl -H "Authorization: Bearer $WEBVYZE_KEY" \
  https://webvyze.com/api/v1/sites/{site}/widget/budgets

Link to this endpoint

PUT/sites/{site}/widget/budgetsPerformance budgets (GET) or set them (PUT)

Needs a token with api:write. Needs the sites.manage permission in the account.

Scope: api:write
Path parameters: {site} integer
Responses: 200401402403422429

curl -X PUT -H "Authorization: Bearer $WEBVYZE_KEY" \
  -H "Content-Type: application/json" -d '{}' \
  https://webvyze.com/api/v1/sites/{site}/widget/budgets

Link to this endpoint

GET/sites/{site}/widget/dailyReal-user metrics per day, with deploys

Needs access to the site, when there is one.

Scope: api:read
Path parameters: {site} integer
Responses: 200401402403422429

curl -H "Authorization: Bearer $WEBVYZE_KEY" \
  https://webvyze.com/api/v1/sites/{site}/widget/daily

Link to this endpoint

GET/sites/{site}/widget/funnelGuided optimization step

Needs access to the site, when there is one.

Scope: api:read
Path parameters: {site} integer
Responses: 200401402403422429

curl -H "Authorization: Bearer $WEBVYZE_KEY" \
  https://webvyze.com/api/v1/sites/{site}/widget/funnel

Link to this endpoint

POST/sites/{site}/widget/keyRotate the real-user script key

Needs a token with api:write. Needs the sites.manage permission in the account.

Scope: api:write
Path parameters: {site} integer
Responses: 200401402403422429

curl -X POST -H "Authorization: Bearer $WEBVYZE_KEY" \
  -H "Content-Type: application/json" -d '{}' \
  https://webvyze.com/api/v1/sites/{site}/widget/key

Link to this endpoint

PUT/sites/{site}/widget/page-groupsSet page types

Needs a token with api:write. Needs the sites.manage permission in the account.

Scope: api:write
Path parameters: {site} integer
Responses: 200401402403422429

curl -X PUT -H "Authorization: Bearer $WEBVYZE_KEY" \
  -H "Content-Type: application/json" -d '{}' \
  https://webvyze.com/api/v1/sites/{site}/widget/page-groups

Link to this endpoint

GET/sites/{site}/widget/releasesEach deploy measured on real visitors: p75 before and after, verdict

Needs access to the site, when there is one.

Scope: api:read
Path parameters: {site} integer
Responses: 200401402403422429

curl -H "Authorization: Bearer $WEBVYZE_KEY" \
  https://webvyze.com/api/v1/sites/{site}/widget/releases

Link to this endpoint

GET/sites/{site}/widget/settingsReal-user script privacy, sessions and conversion pages (GET) or set them (PUT)

Needs the sites.manage permission in the account.

Scope: api:read
Path parameters: {site} integer
Responses: 200401402403422429

curl -H "Authorization: Bearer $WEBVYZE_KEY" \
  https://webvyze.com/api/v1/sites/{site}/widget/settings

Link to this endpoint

PUT/sites/{site}/widget/settingsReal-user script privacy, sessions and conversion pages (GET) or set them (PUT)

Needs a token with api:write. Needs the sites.manage permission in the account.

Scope: api:write
Path parameters: {site} integer
Responses: 200401402403422429

curl -X PUT -H "Authorization: Bearer $WEBVYZE_KEY" \
  -H "Content-Type: application/json" -d '{}' \
  https://webvyze.com/api/v1/sites/{site}/widget/settings

Link to this endpoint

GET/sites/{site}/widget/viewsLatest slow real-user views

Needs access to the site, when there is one.

Scope: api:read
Path parameters: {site} integer
Responses: 200401402403422429

curl -H "Authorization: Bearer $WEBVYZE_KEY" \
  https://webvyze.com/api/v1/sites/{site}/widget/views

Link to this endpoint

GET/sites/{site}/widget/views/{id}One real-user view in detail

Needs access to the site, when there is one.

Scope: api:read
Path parameters: {site} integer{id} string
Responses: 200401402403422429

curl -H "Authorization: Bearer $WEBVYZE_KEY" \
  https://webvyze.com/api/v1/sites/{site}/widget/views/{id}

Link to this endpoint

GET/wordpress-pluginWordPress plugin: current version and the version each site reports

Needs access to the site, when there is one.

Scope: api:read
Responses: 200401402403422429

curl -H "Authorization: Bearer $WEBVYZE_KEY" \
  https://webvyze.com/api/v1/wordpress-plugin

Link to this endpoint