---
title: "Shared Web Vitals summary"
method: GET
path: "/api/share/{token}/sites/{id}/web-vitals/summary"
tags: ["Share"]
---

# Shared Web Vitals summary

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

## Request

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

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

## Path parameters

- `token` string, required
- `id` string, uuid, required

## Query parameters

- `from` string, date-time
- `to` string, date-time
- `path` string
- `rating` 'good' | 'needs_improvement' | 'poor'
- `metric` 'LCP' | 'INP' | 'CLS' | 'FCP' | 'TTFB'

## Response `200`

Web Vitals summary

- WebVitalSummaryMetric[]
  - `good` integer
  - `metric` 'LCP' | 'INP' | 'CLS' | 'FCP' | 'TTFB'
  - `needs_improvement` integer
  - `p75` number
  - `poor` integer
  - `rating` 'good' | 'needs_improvement' | 'poor'
  - `samples` integer

---

[API](https://skmtc.dev/hitkeep/apis/hitkeep-rest-api.md) · [All operations](https://skmtc.dev/hitkeep/apis/hitkeep-rest-api/llms.txt) · [OpenAPI document](https://skmtc.dev/hitkeep/apis/hitkeep-rest-api/revisions/bb2df36ab2a4?raw)