Skip to content
v3 API/
/
Get Page Details Web Vita...

Get Page Details Web Vitals specific trend values relative to current day

Request

GET /v3/web-audits/{auditId}/pages/{pageId}/trends/web-vitals/{trendName}
Security
API_Key
Path
auditIdinteger, (int64)required

Unique identification number for web audit

Example:107239
pageIdstringrequired

Unique identification number for web audit run-page, it is different from dcUUID

Example:f9d32cc7cc2046d6decb145a80289287f5226323
trendNamestringrequired
Enum:"largest_contentful_paint""first_contentful_paint""time_to_first_byte""cumulative_layout_shift"
Query
daysinteger, [ 1 .. 390 ]required

Number of days to get trend values for, relative to current time

GET
/v3/web-audits/{auditId}/pages/{pageId}/trends/web-vitals/{trendName}
curl -i -X GET \
  'https://api.observepoint.com/v3/web-audits/107239/pages/f9d32cc7cc2046d6decb145a80289287f5226323/trends/web-vitals/{trendName}?days=1' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Page Details Web Vitals specific trend values

Bodyapplication/json
statsobjectrequired

Web Vitals trends statistics (min, max, average, median)

runsArray of objectsrequired
Response
{
  "stats": {
    "min": 0.1,
    "max": 0.1,
    "average": 0.1,
    "median": 0.1
  },
  "runs": [
    { … }
  ]
}