Skip to content
v3 API/
/
Return specific page info...

Return specific page information

Request

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

Get page information from specified audit run on a given page

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
pageIdstringrequired

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

Example:f9d32cc7cc2046d6decb145a80289287f5226323
Query
withLinkSummaryboolean

Parameter to request inclusion of links in response

Default:false
withParentPageboolean

Parameter to request inclusion of parent in response

Default:false
withScreenshotUrlboolean

Parameter to request inclusion of screenshot in response

Default:false
GET
/v3/web-audits/{auditId}/runs/{runId}/pages/{pageId}/info
curl -i -X GET \
  'https://api.observepoint.com/v3/web-audits/107239/runs/33010/pages/f9d32cc7cc2046d6decb145a80289287f5226323/info?withLinkSummary=false&withParentPage=false&withScreenshotUrl=false' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Page Info by page Id

Bodyapplication/json
initialPageUrlstring

Initial page URL - before the first redirect. If there were no redirects, equal to finalPageUrl

loadTimenumber
initialStatusCodeinteger

Initial page status code - before the first redirect. If there were no redirects, equal to finalStatusCode

sizenumber
screenshotstring
parentobject
finalPageUrlstring, <= 11264 characters

Final page URL - after all redirects. If there were no redirects, equal to initialPageUrl

Example:"https://example.com/some-path"
finalStatusCodeinteger

Final status code - after all redirects. If there were no redirects, equal to initialStatusCode

Example:302
titleobject

Page title as displayed by browser

Example:"My Cards - ObservePoint"
browserErrorstring

error produced by browser upon opening the page

Example:"This site can’t be reached. example.com’s server IP address could not be found. ERR_NAME_NOT_RESOLVED"
visitStartTimestampinteger, (int64)

timestamp - GMT in milliseconds

Example:1637944293
visitEndTimestampinteger, (int64)

timestamp - GMT in milliseconds

Example:1637944293
redirectsArray of objects, <= 100 items

NULL if page had no redirects. Does not include final page

linksobject
onPageActionResultsArray of objects, non-empty

(Optional) Present if failure/s is/are present in On-Page Actions execution

webVitalsSummaryobject

Google's Web Vitals metrics for a given page

accessibilityChecksSummaryobject
urlstringdeprecated

Deprecated - use initialPageUrl instead

statusCodeintegerdeprecated

Deprecated - use initialStatusCode instead

Example:200
Response
{
  "url": "string",
  "initialPageUrl": "string",
  "loadTime": 0,
  "statusCode": 200,
  "initialStatusCode": 0,
  "size": 0,
  "screenshot": "string",
  "parent": {
    "pageId": "string",
    "pageUrl": "string"
  },
  "finalPageUrl": "https://example.com/some-path",
  "finalStatusCode": 302,
  "title": "My Cards - ObservePoint",
  "browserError": "This site can’t be reached. example.com’s server IP address could not be found. ERR_NAME_NOT_RESOLVED",
  "visitStartTimestamp": 1637944293,
  "visitEndTimestamp": 1637944293,
  "redirects": [
    { … }
  ],
  "links": {
    "linkToInitialUrlCount": 32,
    "linkToFinalUrlCount": 12,
    "linksFromThisPageV2": { … }
  },
  "onPageActionResults": [
    { … }
  ],
  "webVitalsSummary": {
    "largestContentfulPaint": { … },
    "cumulativeLayoutShift": { … },
    "firstContentfulPaint": { … },
    "timeToFirstByte": { … }
  },
  "accessibilityChecksSummary": {
    "configurationTags": [ … ],
    "scores": { … },
    "issues": [ … ],
    "inconclusive": [ … ]
  }
}