seo-connect
GET /v1/seo-connection/crux
Real-visitor Core Web Vitals (Chrome UX Report) for the site. Free.
Authentication
Send an API key as a bearer token. The endpoint checks sites.view; a key without it is refused with 403, not 404.
This endpoint takes no organisation id. Your key already identifies the organisation it belongs to, and the response is scoped to it.
Try it
Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.
curl -X GET https://api.zinndigital.com/v1/seo-connection/crux \
-H "Authorization: Bearer zdk_live_…"Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console
Details
What real Chrome users experienced on the connected site's origin (or one of its pages) over Google's rolling 28 days: p75 and the good / needs-improvement / poor split for LCP, INP, CLS, FCP and TTFB, and Google's Core Web Vitals assessment. Read from the CrUX API, or from the same record inside PageSpeed Insights; cached a day per origin or page and form factor (cached). A site below CrUX's traffic threshold is has_data: false — an answer, not an error; a page never borrows its origin's numbers. Free. Needs seo.read.
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
url (query) | string | No | A page or the home page of the connected site; defaults to the home page. |
scope (query) | string<origin, url> | No | — |
form_factor (query) | string<phone, desktop> | No | — |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
url | string | Yes | The origin or page that was looked up. |
scope | string<origin, url> | Yes | — |
form_factor | string<phone, desktop> | Yes | — |
source | string<crux_api, pagespeed> | Yes | — |
has_data | boolean | Yes | False when the site is below CrUX's traffic threshold. |
metrics | object | Yes | Keyed lcp, inp, cls, fcp, ttfb; absent metrics are omitted. |
overall | object | Yes | Google's Core Web Vitals assessment (LCP, INP and CLS all good = good). |
collection_period | object | Yes | — |
fetched_at | string | Yes | — |
cached | boolean | Yes | — |
Errors this endpoint can return
401 · 403 · 422 · 429 · 503