Skip to content
v3 API/
/
Download page 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"
GET
/v3/web-audits/{auditId}/runs/{runId}/pages/{pageId}/links/{linkDirection}/download
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
string