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 Tag Privacy 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
Use in filtering purposes is DEPRECATED in favour of ConsentCategoryId! Snapshot Id of consent category attached to this run
Example: 33010
- ObservePoint Production API
https://api.observepoint.com/v3/web-audits/{auditId}/runs/{runId}/reports/tag-privacy
- 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/tag-privacy \
-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,
"primaryTagsOnly": true,
"tagId": 0,
"tagCategoryId": 0,
"tagVendorId": 0,
"tagAccount": "string",
"consentCategoryId": 3301,
"consentCategorySnapshotId": 33010,
"consentCategoryComplianceStatus": "approved"
}'Response
application/json
{ "totalPageCount": 0, "filteredPageCount": 0, "totalUniqueTagCount": 0, "filteredUniqueTagCount": 0, "totalApprovedTagCount": 0, "filteredApprovedTagCount": 0, "totalUnapprovedTagCount": 0, "filteredUnapprovedTagCount": 0, "filteredPageWithUnapprovedTagCount": 0, "runHasNoConsentCategoriesAssigned": true }
- ObservePoint Production API
https://api.observepoint.com/v3/web-audits/{auditId}/runs/{runId}/reports/tag-privacy/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/tag-privacy/trends \
-H 'Authorization: YOUR_API_KEY_HERE'Tag Privacy 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/tag-privacy/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/tag-privacy/trends/{trendName}?days=1' \
-H 'Authorization: YOUR_API_KEY_HERE'Tag Privacy specific trend values
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 Tag Privacy 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
Use in filtering purposes is DEPRECATED in favour of ConsentCategoryId! Snapshot Id of consent category attached to this run
Example: 33010
- ObservePoint Production API
https://api.observepoint.com/v3/web-audits/{auditId}/runs/{runId}/reports/tag-privacy/compliance
- 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/tag-privacy/compliance?page=0&size=100&sortBy=compliance_status&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,
"primaryTagsOnly": true,
"tagId": 0,
"tagCategoryId": 0,
"tagVendorId": 0,
"tagAccount": "string",
"consentCategoryId": 3301,
"consentCategorySnapshotId": 33010,
"consentCategoryComplianceStatus": "approved"
}'Tag Privacy compliance data
Common metadata for iterable
Total number of items available from all result pages combined
Page size - number of items per result page configured by size query parameter or default page size
Use in filtering purposes is DEPRECATED in favour of ConsentCategoryId! Snapshot Id of consent category attached to this run
Example: 33010
Name of consent category item (tag, cookie, domain, geo) belongs to
Response
application/json
{ "metadata": { "pagination": { … } }, "tags": [ { … } ] }
Query
Bodyapplication/json Enum"page_url""final_page_url""page_load_time""page_status_code""final_page_status_code""tag_count"
Filters applicable to Tag Privacy 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
Use in filtering purposes is DEPRECATED in favour of ConsentCategoryId! Snapshot Id of consent category attached to this run
Example: 33010
- ObservePoint Production API
https://api.observepoint.com/v3/web-audits/{auditId}/runs/{runId}/reports/tag-privacy/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/tag-privacy/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,
"primaryTagsOnly": true,
"tagId": 0,
"tagCategoryId": 0,
"tagVendorId": 0,
"tagAccount": "string",
"consentCategoryId": 3301,
"consentCategorySnapshotId": 33010,
"consentCategoryComplianceStatus": "approved"
}'Response
application/json
{ "metadata": { "pagination": { … } }, "pages": [ { … } ] }
Query
Bodyapplication/jsonrequired Enum"page_url""final_page_url""page_load_time""page_status_code""final_page_status_code""tag_count"
Filters applicable to Tag Privacy 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/tag-privacy/tag-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/tag-privacy/tag-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,
"tagId": 0,
"tagAccount": "string"
}'Response
application/json
{ "metadata": { "pagination": { … } }, "pages": [ { … } ] }