This section documents the V3 Reporting API endpoints that provide access to comprehensive audit and journey data from ObservePoint. Use these endpoints to retrieve detailed reports, export data, manage alerts, and analyze web performance metrics from your ObservePoint scans.
V3 API
Download OpenAPI description
Overview
Languages
Servers
ObservePoint Production API
https://api.observepoint.com/
Bodyapplication/json
Filters applicable to Browser Logs 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.
- ObservePoint Production API
https://api.observepoint.com/v3/web-audits/{auditId}/runs/{runId}/reports/browser-logs
- 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/browser-logs \
-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",
"tagId": 0,
"tagCategoryId": 0,
"tagVendorId": 0,
"level": "error",
"messageText": {
"filterType": "contains",
"filterValue": "string"
},
"anyRelatedTag": true
}'Response
application/json
{ "errorLogCount": 0, "warnLogCount": 0, "infoLogCount": 0, "debugLogCount": 0, "otherLogCount": 0, "totalPageCount": 0, "filteredPageCount": 0 }
- ObservePoint Production API
https://api.observepoint.com/v3/web-audits/{auditId}/runs/{runId}/reports/browser-logs/trends
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
https://api.observepoint.com/v3/web-audits/107239/runs/33010/reports/browser-logs/trends \
-H 'Authorization: YOUR_API_KEY_HERE'Browser Logs trends data
Date-time in RFC3339 profile ISO 8601 format with the following additional restrictions:
- An uppercase T must separate the date and time portions.
- An uppercase Z must denote that a numeric time zone offset isn't present.
In general, these timestamp requirements are the same in AWS Step Functions - Choice Rules
Example: "2016-08-18T17:33:00Z"
Response
application/json
{ "runs": [ { … } ] }
- ObservePoint Production API
https://api.observepoint.com/v3/web-audits/{auditId}/reports/browser-logs/trends/{trendName}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://api.observepoint.com/v3/web-audits/107239/reports/browser-logs/trends/{trendName}?days=1' \
-H 'Authorization: YOUR_API_KEY_HERE'Browser Logs specific trend values data
Date-time in RFC3339 profile ISO 8601 format with the following additional restrictions:
- An uppercase T must separate the date and time portions.
- An uppercase Z must denote that a numeric time zone offset isn't present.
In general, these timestamp requirements are the same in AWS Step Functions - Choice Rules
Example: "2016-08-18T17:33:00Z"
Response
application/json
{ "runs": [ { … } ] }
Bodyapplication/json
Filters applicable to Browser Logs 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.
- ObservePoint Production API
https://api.observepoint.com/v3/web-audits/{auditId}/runs/{runId}/reports/browser-logs/messages
- 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/browser-logs/messages?page=0&size=50&sortBy=level&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",
"tagId": 0,
"tagCategoryId": 0,
"tagVendorId": 0,
"level": "error",
"messageText": {
"filterType": "contains",
"filterValue": "string"
},
"anyRelatedTag": true
}'Response
application/json
{ "metadata": { "pagination": { … } }, "messages": [ { … } ] }
Query
Bodyapplication/json Enum"page_url""final_page_url""page_load_time""page_status_code""final_page_status_code""error_log_count""warn_log_count""info_log_count""debug_log_count""other_log_count"
Filters applicable to Browser Logs 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.
- ObservePoint Production API
https://api.observepoint.com/v3/web-audits/{auditId}/runs/{runId}/reports/browser-logs/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/browser-logs/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",
"tagId": 0,
"tagCategoryId": 0,
"tagVendorId": 0,
"level": "error",
"messageText": {
"filterType": "contains",
"filterValue": "string"
},
"anyRelatedTag": true,
"message": {
"message": "string",
"level": "error"
}
}'Response
application/json
{ "metadata": { "pagination": { … } }, "pages": [ { … } ] }