hosting

GET /v1/sites/{siteId}/vitals

Get a site's homepage Core Web Vitals.

Minden hosting végpont

Hitelesítés

Küldjön egy API-kulcsot bearer tokenként. Ez a végpont nem határoz meg konkrét jogosultságot a specifikációban, ezért adja meg a kulcsnak a legkevesebbet, amire szüksége van, és a feltételezés helyett ellenőrizze a választ.

Ez a végpont nem fogad el szervezeti azonosítót. Az Ön kulcsa már azonosítja azt a szervezetet, amelyhez tartozik, és a válasz is erre vonatkozik.

Próbálja ki

Cserélje ki a hegyes zárójelek közötti részt a saját értékeivel, a kulcshelyőrzőt pedig a vezérlőpultján található kulccsal.

curl -X GET https://api.zinndigital.com/v1/sites/{siteId}/vitals \
  -H "Authorization: Bearer zdk_live_…"

Be van jelentkezve? A vezérlőpultban lévő API-konzol kitölti a valós szervezetazonosítóját és a saját kulcsát, és a kérést az éles API-n futtatja, hogy láthassa a tényleges választ. Nyissa meg ezt a végpontot az API konzolban

Részletek

The site's newest Core Web Vitals reading — LCP, CLS and INP for its **homepage**, with the "good / needs improvement / poor" band for each and for the reading as a whole. Backs the Performance tab's vitals card and the free SEO Basics tile, both of which are sold as included on every plan and every site. RLS-scoped to a site the caller can view (`sites.view`); an out-of-scope or unknown id is a `404`, exactly like `getSite`. **Homepage only, by design.** Every surface that sells this sells *homepage* Core Web Vitals. Measuring every URL of every site is a different product. **Collection is asynchronous.** Readings are taken off the request path by a scheduled collector and read back here — a live Lighthouse run would be a 20-second uncached external call on a tab that mounts for every site (CLAUDE.md §2.16). Until a site has been measured, `available` is `false`, every metric is `null` and every band is `unknown`. **`source` must be rendered.** A `lab` reading is a synthetic Lighthouse run; a `field` reading is what real Chrome users experienced (Chrome UX Report) and is what Google ranks on. Field data does not exist for sites below CrUX's traffic threshold — which is most low-traffic sites — so `lab` is the coverage tier. Presenting a lab score as though real users produced it is a false claim about what visitors experienced, so clients must label which one they are showing.

Paraméterek

NévTípusKötelezőMi ez
siteId (path)UuidIgenSite ID (UUIDv7).

Válasz

NévTípusKötelezőMi ez
availablebooleanIgenWhether any vitals reading exists for this site yet.
urlstringIgenThe exact URL measured. Empty when unavailable.
sourcestring<field, lab, >Igen`field` = Chrome UX Report (real users, what Google ranks on); `lab` = a synthetic Lighthouse run. Clients MUST label which is shown. Empty string when unavailable, following `p…
field_availablebooleanIgenWhether real-user (field) data exists for this site at all, independent of which reading is returned — so the UI can say "no real-user data yet" while still showing the lab number.
lcp_msobjectIgenLargest Contentful Paint, p75, milliseconds. Good ≤ 2500, poor > 4000.
cls_milliobjectIgenCumulative Layout Shift, p75, in **thousandths** (0.083 → `83`). An integer so no band comparison is ever made against a float at the 0.1/0.25 boundaries; clients render `cls_mi…
inp_msobjectIgenInteraction to Next Paint, p75, milliseconds. Good ≤ 200, poor > 500. INP replaced First Input Delay as a Core Web Vital in March 2024; FID is retired and is deliberately not re…
ttfb_msobjectIgenTime to First Byte — a diagnostic, not a Core Web Vital.
fcp_msobjectIgenFirst Contentful Paint — a diagnostic, not a Core Web Vital.
performance_scoreobjectIgenLighthouse performance score, 0–100. Always `null` on a `field` reading — the Chrome UX Report computes no score, and inventing one would present a number Google never produced.
accessibility_scoreobjectIgenLighthouse accessibility score, 0–100 (docs/85 §2.1). Lighthouse computes all four of its categories from a **single** page load, so this costs about a second on a 10–30 s run —…
best_practices_scoreobjectIgenLighthouse best-practices score, 0–100 — mixed content, deprecated APIs, console errors. `null` on a `field` reading.
seo_scoreobjectIgenLighthouse SEO score, 0–100. `null` on a `field` reading.
stack_packsstring[]IgenThe technology stacks Lighthouse detected on this run (`wordpress`, `woocommerce`, …). **Ids only.** Lighthouse also ships stack-specific remediation *text*; that is untranslate…
bandVitalsBandIgenA Core Web Vitals verdict against Google's published p75 thresholds. The overall `band` is the **worst** of the three measured metrics, because that is how Google assesses a pag…
lcp_bandVitalsBandIgenA Core Web Vitals verdict against Google's published p75 thresholds. The overall `band` is the **worst** of the three measured metrics, because that is how Google assesses a pag…
cls_bandVitalsBandIgenA Core Web Vitals verdict against Google's published p75 thresholds. The overall `band` is the **worst** of the three measured metrics, because that is how Google assesses a pag…
inp_bandVitalsBandIgenA Core Web Vitals verdict against Google's published p75 thresholds. The overall `band` is the **worst** of the three measured metrics, because that is how Google assesses a pag…
measured_atobjectIgen
opportunitiesSiteVitalsOpportunity[]IgenWhat is actually making this page slow, **largest saving first** — the "why" behind the numbers above. ⚠️ An empty array does **not** mean "nothing to fix". It means this readin…
screenshotsSiteVitalsScreenshotsIgenWhat the page looked like while it loaded — the filmstrip and the finished render. `available` is reported separately from the parent envelope's flag because a perfectly good me…

Hibák, amelyeket ez a végpont visszaadhattatlan

401 · 403 · 404 · 429