Sites

Get Web Vitals visitor context breakdown

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.

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

Request

  • Base URL: https://demo.hitkeep.com
  • URL: https://demo.hitkeep.com/api/sites/{id}/web-vitals/breakdown
  • Auth: one of:
    • API key in cookie hk_token
    • HTTP bearer
    • API key in header X-API-Key

Path parameters

idstring uuid required

Query parameters

fromstring date-time
tostring date-time
pathstring

Exact normalized page path.

rating'good' | 'needs_improvement' | 'poor'

Web Vital threshold rating.

metric'LCP' | 'INP' | 'CLS' | 'FCP' | 'TTFB'

Web Vital metric.

dimension'browser' | 'country' | 'language' | 'device' | 'city' | 'provider' | 'asn' required

Visitor context dimension.

limitinteger

Response

Web Vitals breakdown

goodinteger
namestring
needs_improvementinteger
p75number
poorinteger
rating'good' | 'needs_improvement' | 'poor'
samplesinteger

Changes

No recorded changes to this operation across all 1 revision of this API.