Get Web Vitals visitor context breakdown

GET

/api/sites/{id}/web-vitals/breakdown

const url = 'https://hitkeep.com/api/sites/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/web-vitals/breakdown?rating=good&metric=LCP&dimension=browser';
const options = {method: 'GET', headers: {cookie: 'hk_token=<hk_token>'}};

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://hitkeep.com/api/sites/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/web-vitals/breakdown?rating=good&metric=LCP&dimension=browser' \
  --cookie hk_token=<hk_token>

Returns Web Vitals p75 and rating counts for one metric grouped by browser, country, language, device, city, provider, or ASN using the matching pageview context.

Authorizations

Parameters

Path Parameters

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

required

string

Allowed values: LCP INP CLS FCP TTFB

Web Vital metric.

dimension

required

string

Allowed values: browser country city provider asn language device

Visitor context dimension.

limit

integer

>= 1 <= 100

Responses

200

Web Vitals breakdown

application/json

Array<object>

object

name

string

p75

number

samples

integer

good

integer

needs_improvement

integer

poor

integer

rating

string

Allowed values: good needs_improvement poor

Example

[
  {
    "rating": "good"
  }
]