Shared Web Vitals summary REST API

GET

/api/share/{token}/sites/{id}/web-vitals/summary

const url = 'https://app.hitkeep.com/api/share/example/sites/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/web-vitals/summary?rating=good&metric=LCP';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://app.hitkeep.com/api/share/example/sites/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/web-vitals/summary?rating=good&metric=LCP'

Returns Web Vitals summary through a read-only share token.

Parameters

Path Parameters

token

required

string

required

string format: uuid

Query Parameters

from

string format: date-time

path

string

Exact normalized page path.

rating

string

Allowed values: good needs_improvement poor

Web Vital threshold rating.

metric

string

Allowed values: LCP INP CLS FCP TTFB

Web Vital metric.

Responses

200

Web Vitals summary

application/json

Array<object>

object

good

integer

metric

string

Allowed values: LCP INP CLS FCP TTFB

needs_improvement

integer

p75

number

poor

integer

rating

string

Allowed values: good needs_improvement poor

samples

integer

Example

[
  {
    "metric": "LCP",
    "rating": "good"
  }
]