Spoar
All projects

Speed per route across projects

GET
/v2/speed/routes

As the per-project route.

Authorization

AuthorizationBearer <token>

An API token from POST /v2/tokens (at_live_...), or a project's secret key (sk_...) for server-side ingest.

In: header

Query Parameters

from?string

Start of the range; send with to.

Formatdate-time
to?string

End of the range, exclusive.

Formatdate-time
period?string

A range ending at the start of today in UTC (24h ends at the start of this hour). Ignored when from and to are sent; 30d by default.

Value in

  • "24h"
  • "7d"
  • "30d"
  • "90d"
  • "12mo"
  • "all"
filter?

filter[route], filter[page] and filter[country]; a value, or !value to exclude.

device?string

mobile (tablets included), desktop or all (the default).

Value in

  • "mobile"
  • "desktop"
  • "all"
environment?string

production (the default) leaves preview deployments out, preview keeps only them, all keeps both.

Value in

  • "production"
  • "preview"
  • "all"
interval?string

Bucket size in UTC: day (the default) or hour, which covers at most 7 days and only the last 30 days of raw samples.

Value in

  • "hour"
  • "day"
group?string

route (the default) groups by the route the SDK reported, falling back to the path; path groups by the path.

Value in

  • "route"
  • "path"
minShare?string

speed/routes only: leaves out routes with less than this share of the samples, from 0 to 1; default 0.005, 0 keeps them all.

Match^(0(\.\d+)?|1(\.0+)?)$
percentile?string

Which percentile of the samples the values show; default 75.

Value in

  • "50"
  • "75"
  • "90"
  • "95"
  • "99"
metric?string

The Web Vital: lcp, inp, cls, fcp or ttfb. Required on speed/timeseries and speed/elements.

Value in

  • "lcp"
  • "inp"
  • "cls"
  • "fcp"
  • "ttfb"
limit?|

Rows per page, 1 to 100 (default 20), or up to 1000 with format.

Range1 <= value <= 1000
cursor?string

The opaque nextCursor of the previous page.

Length1 <= length

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v2/speed/routes"
{  "data": [    {      "route": "/blog/[slug]",      "score": 85,      "samples": 344,      "lcp": 3120,      "inp": 180,      "cls": 0.12,      "fcp": 1680,      "ttfb": 460    },    {      "route": "/",      "score": 99,      "samples": 812,      "lcp": 1840,      "inp": 96,      "cls": 0.02,      "fcp": 1020,      "ttfb": 310    }  ],  "nextCursor": "eyJvIjoyfQ"}

One metric per day across projects GET

Previous Page

Elements behind slow values across projects GET

Next Page