Skip to content
v3 API/
/
Return pages found in the...

Return pages found in the run

Request

GET /v3/web-audits/{auditId}/runs/{runId}/pages

Get all the pages in a given audit run

Security
API_Key
Path
auditIdinteger, (int64)required

Unique identification number for web audit

Example:107239
runIdinteger, (int64)required

Unique identification number for web audit or journey run

Example:33010
Query
pageinteger, >= 0

Page number, starts with 0

Default:0
sizeinteger, [ 50 .. 1000 ]
Default:50
sortBystring

possible ways to sort pages in a given run

Enum:"url""load_time""status_code""size"
sortDescboolean

Controls sorting order

Default:false
GET
/v3/web-audits/{auditId}/runs/{runId}/pages
curl -i -X GET \
  'https://api.observepoint.com/v3/web-audits/107239/runs/33010/pages?page=0&size=50&sortBy=url&sortDesc=false' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

OK, return a list of unique pages found

Bodyapplication/json
metadataobjectrequired

Common metadata for iterable

pagesArray of objectsrequired
Response
{
  "metadata": {
    "pagination": { … }
  },
  "pages": [
    { … }
  ]
}