Sign in
Performance

Get performance metrics

get/performance/metrics

Request

  • Base URL: /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/performance/metrics
  • Auth: HTTP bearer

Query parameters

start_datestring required

Start date in format YYYY-MM-DD HH:MM:SS

end_datestring required

End date in format YYYY-MM-DD HH:MM:SS

project_idinteger required

Project ID or slug

environment_idinteger

Environment ID (optional)

deployment_idinteger

Deployment ID (optional)

device_typestring

Device type filter: desktop or mobile (optional)

include_botsboolean

Include crawler/datacenter bot samples (default false)

filter_pathstring

Filter to one page pathname, exact match (optional). path is accepted as an alias.

filter_countrystring

Filter to one country (optional)

filter_regionstring

Filter to one region (optional)

filter_citystring

Filter to one city (optional)

filter_browserstring

Filter to one browser (optional)

filter_operating_systemstring

Filter to one operating system (optional)

Response

Successfully retrieved performance metrics

clsnumber float nullable
cls_p75number float nullable
cls_p90number float nullable
cls_p95number float nullable
cls_p99number float nullable
fcpnumber float nullable
fcp_p75number float nullable
fcp_p90number float nullable
fcp_p95number float nullable
fcp_p99number float nullable
fidnumber float nullable
fid_p75number float nullable
fid_p90number float nullable
fid_p95number float nullable
fid_p99number float nullable
inpnumber float nullable
inp_p75number float nullable
inp_p90number float nullable
inp_p95number float nullable
inp_p99number float nullable
lcpnumber float nullable
lcp_p75number float nullable
lcp_p90number float nullable
lcp_p95number float nullable
lcp_p99number float nullable
ttfbnumber float nullable
ttfb_p75number float nullable
ttfb_p90number float nullable
ttfb_p95number float nullable
ttfb_p99number float nullable

Changes

No recorded changes to this operation across all 50 revisions of this API.