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.
v3 API//
- Get File Changes pages for specific file in specified audit run
Get File Changes summary for specified audit run
Get File Changes files for specified audit run
Get File Changes pages for specified audit run
Get File Changes pages fo...
V3 API
Download OpenAPI description
Overview
Languages
Servers
ObservePoint Production API
https://api.observepoint.com/
Bodyapplication/json
Filters applicable to File Changes report
broken- initial or final URL arebroken,good- initial URL isgoodorredirectand final URL isgood
Enum"broken""good"
Page load time in milliseconds. Should have min and/or max properties defined. min is inclusive and max is exclusive. min should be less than max.
Page size in bytes. Should have min and/or max properties defined. min is inclusive and max is exclusive. min should be less than max.
Number of redirects for a page. Should have min and/or max properties defined. min is inclusive and max is exclusive. min should be less than max.
if true then return only pages/tags with primary tags else return all pages/tags
Filters absolute difference values, e.g. when min = 200 then -300 diff passes filter. Should have min and/or max properties defined. min is inclusive, max is exclusive.
Filters absolute difference values, e.g. when min = 200 then -300 diff passes filter. Should have min and/or max properties defined. min is inclusive, max is exclusive.
Name of the file. Identified as the last non-empty part of URL path
Example: "main.js"
- ObservePoint Production APIhttps://api.observepoint.com/v3/web-audits/{auditId}/runs/{runId}/reports/file-changes/pages
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
'https://api.observepoint.com/v3/web-audits/107239/runs/33010/reports/file-changes/pages?page=0&size=50&sortBy=page_url&sortDesc=false' \
-H 'Authorization: YOUR_API_KEY_HERE' \
-H 'Content-Type: application/json' \
-d '{
"pageUrl": {
"filterType": "contains",
"filterValue": "string",
"negated": false
},
"finalPageUrl": {
"filterType": "contains",
"filterValue": "string",
"negated": false
},
"pageTitle": {
"filterType": "contains",
"filterValue": "ObserveP"
},
"initialPageStatusCode": {
"filterType": "specific",
"negated": true
},
"finalPageStatusCode": {
"filterType": "specific",
"negated": true
},
"combinedPageStatusCode": "broken",
"pageLoadTime": {
"min": 0,
"max": 0
},
"pageSize": {
"min": 0,
"max": 0
},
"redirectCount": {
"min": 0,
"max": 0
},
"hasBrokenLinks": true,
"pageUrlMatchingAuditFilterConfiguration": true,
"pageStatusCode": "good",
"primaryTagsOnly": true,
"tagId": 0,
"tagCategoryId": 0,
"tagVendorId": 0,
"dateDifference": {
"min": 1,
"max": 1
},
"sizeDifference": {
"min": 1,
"max": 1
},
"filename": "main.js",
"changeType": "new_file",
"anyRelatedTag": true
}'Response
application/json
{ "metadata": { "pagination": { … } }, "pages": [ { … } ] }
Bodyapplication/jsonrequired
Filters applicable to File Changes report
broken- initial or final URL arebroken,good- initial URL isgoodorredirectand final URL isgood
Enum"broken""good"
Page load time in milliseconds. Should have min and/or max properties defined. min is inclusive and max is exclusive. min should be less than max.
Page size in bytes. Should have min and/or max properties defined. min is inclusive and max is exclusive. min should be less than max.
Number of redirects for a page. Should have min and/or max properties defined. min is inclusive and max is exclusive. min should be less than max.
Filters absolute difference values, e.g. when min = 200 then -300 diff passes filter. Should have min and/or max properties defined. min is inclusive, max is exclusive.
Filters absolute difference values, e.g. when min = 200 then -300 diff passes filter. Should have min and/or max properties defined. min is inclusive, max is exclusive.
Name of the file. Identified as the last non-empty part of URL path
Example: "main.js"
Indicates the level of similarity of network request URL domain and its page URL domain
Enum"1st_party""3rd_party"
Enum"new_file""not_changed""changed_file""deleted_file""unknown"
- ObservePoint Production APIhttps://api.observepoint.com/v3/web-audits/{auditId}/runs/{runId}/reports/file-changes/file-pages
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
'https://api.observepoint.com/v3/web-audits/107239/runs/33010/reports/file-changes/file-pages?page=0&size=50&sortBy=page_url&sortDesc=false' \
-H 'Authorization: YOUR_API_KEY_HERE' \
-H 'Content-Type: application/json' \
-d '{
"pageUrl": {
"filterType": "contains",
"filterValue": "string",
"negated": false
},
"finalPageUrl": {
"filterType": "contains",
"filterValue": "string",
"negated": false
},
"pageTitle": {
"filterType": "contains",
"filterValue": "ObserveP"
},
"initialPageStatusCode": {
"filterType": "specific",
"negated": true
},
"finalPageStatusCode": {
"filterType": "specific",
"negated": true
},
"combinedPageStatusCode": "broken",
"pageLoadTime": {
"min": 0,
"max": 0
},
"pageSize": {
"min": 0,
"max": 0
},
"redirectCount": {
"min": 0,
"max": 0
},
"hasBrokenLinks": true,
"pageUrlMatchingAuditFilterConfiguration": true,
"pageStatusCode": "good",
"dateDifference": {
"min": 1,
"max": 1
},
"sizeDifference": {
"min": 1,
"max": 1
},
"file": {
"filename": "main.js",
"requestDomain": "example.com",
"partyType": "1st_party",
"fileChangeType": "new_file",
"tagId": 0
},
"changeType": "new_file"
}'Response
application/json
{ "metadata": { "pagination": { … } }, "pages": [ { … } ] }