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

V3 API

This section documents the V3 API endpoints that provide access to comprehensive audit and journey data from ObservePoint. Use these endpoints to retrieve detailed reports, export data, manage alerts, configure scans and privacy settings, and analyze web performance metrics from your ObservePoint scans.

Download OpenAPI description
combined.openapi.json
combined.openapi.yaml
Overview
URL
https://www.observepoint.com/contact-us
Languages
Servers
ObservePoint Production API
https://api.observepoint.com/

Alert Summary Report

Alert Summary report endpoints

Operations

Audit Summary Report

Audit Summary report endpoints

Operations

Browser Logs Report

Browser Logs report endpoints

Operations

File Changes Report

File changes report endpoints

Operations

Page Details Report

Detailed information about specific pages including tags, cookies, request logs, and console logs

Operations

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
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 objectsnon-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
application/json
{
  "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": [ … ]
  }
}

Get page links

Request

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

Get up to 1000 page links with specified direction (from/to this page), use downloadPageLinks to get all items

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
linkDirectionstringrequired
Enum"to_this_page""from_this_page"
Query
optionsArray of strings[ 1 .. 3 ] items

Applicable to links from this page

Items Enum"to_internal_pages""to_external_pages""to_urls_not_audited"
thisUrlTypestring

Applicable to links to this page.

  • missing - links pointing to either initial or final url
  • initial - links pointing to initial url,
  • final - links pointing to final url, if there was no redirect, final url will be the the same as initial
Enum"initial""final"
curl -i -X GET \
  'https://api.observepoint.com/v3/web-audits/107239/runs/33010/pages/f9d32cc7cc2046d6decb145a80289287f5226323/links/{linkDirection}?options=to_internal_pages&thisUrlType=initial' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Page links

Bodyapplication/json
linksArray of objects<= 1000 itemsrequired
links[].​initial_page_urlstringrequired

URL initially opened by engine

links[].​initial_page_status_codeintegerrequired

Initial status code observed by engine

links[].​final_page_urlstringrequired

Final URL after all redirects. If no redirects, equal to initial_page_url

links[].​final_page_status_codeintegerrequired

Final status code observed by engine after all redirects. If no redirects, equal to initial_page_status_code

links[].​page_linked_from_urlstringrequired

URL of another page that has link to this page

links[].​outer_htmlstring<= 500 charactersrequired
Example: "<a href='https://www.iana.org/domains/example'>More information...</a>"
Response
application/json
{
  "links": [
    { … }
  ]
}

Download page links

Request

GET /v3/web-audits/{auditId}/runs/{runId}/pages/{pageId}/links/{linkDirection}/download

Download page links with specified direction (from/to this 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
linkDirectionstringrequired
Enum"to_this_page""from_this_page"
Query
optionsArray of strings[ 1 .. 3 ] items

Applicable to links from this page

Items Enum"to_internal_pages""to_external_pages""to_urls_not_audited"
thisUrlTypestring

Applicable to links to this page.

  • missing - links pointing to either initial or final url
  • initial - links pointing to initial url,
  • final - links pointing to final url, if there was no redirect, final url will be the the same as initial
Enum"initial""final"
curl -i -X GET \
  'https://api.observepoint.com/v3/web-audits/107239/runs/33010/pages/f9d32cc7cc2046d6decb145a80289287f5226323/links/{linkDirection}/download?options=to_internal_pages&thisUrlType=initial' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Page links

Headers
content-dispositionstring

Controls the name of the downloaded file (in case of text/csv content)

Example: "attachment; filename=\"page-summary-links-to-this-page-My_Audit-2022-03-22_15-16-17.csv\""
Bodytext/csv
string(csv)

See AuditRun_PageInfo_LinkItem for single row schema

Response
No content

Page Summary Report

Page Summary report endpoints

Operations

Request Privacy Report

Request Privacy report endpoints

Operations

Rule Summary Report

Rule Summary report endpoints

Operations

Tag Duplicates and Multiples Report

Tag Duplicates and Multiples report endpoints

Operations

Tag Health Report

Tag Health report endpoints

Operations

Tag Inventory Report

Tag Inventory report endpoints

Operations

Tag Privacy Report

Tag privacy report endpoints

Operations

Variable Inventory Report

Variable Inventory report endpoints

Operations

Audit Run Data

Retrieve audit run data including pages, cookies, geo-locations, network requests, JS variables and failures for web audit runs

Operations

Account Usage Export

Export account usage data

Operations

Alert Export

Export alert data

Operations

Audit Run Export

Export audit run data

Operations

Exports Center

Access requested exports status/information

Operations

Manual Journey Run Export

Export manual journey run data

Operations

Scheduled Exports

Manage scheduled grid report data exports

Operations

Web Journey Run Export

Export web journey run data

Operations

Account's Triggered Alerts

Account-level triggered alerts

Operations

Account Usage Alerts

Alerts related to account usage

Operations

Alerts

Alert management and configuration

Operations

Email Inbox Message Alerts

Email inbox message alerts

Operations

Account Usage

Account usage data

Operations

Email Inbox Configuration

APIs for managing email inbox configurations and setting

Operations

Email Inbox Messages

Get Email Inbox message details

Operations

Email Inboxes

APIs for getting email messages and results from email inboxes

Operations

Action Set Action Rules

APIs for managing Action Set Action Rules

Operations

Action Set Actions

APIs for managing Action Set Actions

Operations

Action Sets

APIs for managing Action Sets

Operations

Audit Actions

APIs for managing audit actions

Operations

Audit Blocking Config

APIs for managing audit request blocking configuration

Operations

Audit Login Actions

APIs for managing audit login actions

Operations

Audits Management

APIs for managing audits

Operations

Custom Headers

APIs for managing custom HTTP header groups

Operations

Data Sources

APIs for managing Data Sources

Operations

Geo Locations

APIs for geo locations

Operations

Notification Center

Find and manage email subscriptions

Operations

Remote File Mappings

APIs for managing Remote File Mappings

Operations

Rules

APIs for managing rules

Operations

Schedules

APIs for item schedules and calendars

Operations

Site Censuses

APIs for managing Site Census

Operations

User Events

APIs for managing User Events

Operations

Web Journey Blocking Config

APIs for managing web journey request blocking configuration

Operations

Web Journey Custom Headers

APIs for managing web journey custom headers

Operations

Web Journeys Management

APIs for managing Web Journeys

Operations