Share

Shared Web Vitals visitor context breakdown

Returns Web Vitals visitor context breakdown through a read-only share token.

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

Request

  • Base URL: https://demo.hitkeep.com
  • URL: https://demo.hitkeep.com/api/share/{token}/sites/{id}/web-vitals/breakdown
  • Auth: none declared

Path parameters

tokenstring required
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.