Skip to content
v3 API/
/
Get rule details for spec...

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

Page Summary Report

Page Summary report endpoints

Operations

Request Privacy Report

Request Privacy report endpoints

Operations

Rule Summary Report

Rule Summary report endpoints

Operations

Get all rules overview for specified audit run

Request

POST /v3/web-audits/{auditId}/runs/{runId}/reports/rule-summary/rule-results
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
Bodyapplication/json

Filters

pageUrlobject
finalPageUrlobject
pageTitleobject
initialPageStatusCodeobject
finalPageStatusCodeobject
combinedPageStatusCodestring
  • broken - initial or final URL are broken,
  • good - initial URL is good or redirect and final URL is good
Enum"broken""good"
pageLoadTimeobject
pageSizeobject
redirectCountobject
hasBrokenLinksboolean
pageUrlMatchingAuditFilterConfigurationboolean
primaryTagsOnlyboolean

if true then return only rules/pages with primary tags else return all rules/pages

tagIdinteger

Tag ID

tagCategoryIdinteger

Tag category ID

tagVendorIdinteger

Tag vendor ID

tagAccountstring

Tag account

ruleStatusstring
Enum"failed""passed""not_applied"
ruleIdinteger(int64)

Rule ID

Example: 12
pageStatusCodestringDeprecated

good - 2xx, redirects - 3xx, broken - all others

Enum"good""redirects""broken"
ruleFailuresOnlybooleanDeprecated

Use ruleStatus instead

curl -i -X POST \
  https://api.observepoint.com/v3/web-audits/107239/runs/33010/reports/rule-summary/rule-results \
  -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,
    "tagAccount": "string",
    "ruleFailuresOnly": true,
    "ruleStatus": "failed",
    "ruleId": 12
  }'

Responses

Rule Details by Page - all rules overview

Bodyapplication/json
rulesArray of objectsrequired
rules[].​failedRulePageCountintegerrequired

Number of pages with at least 1 rule failed

Default 0
rules[].​passedRulePageCountintegerrequired

Number of pages with at least 1 rule passed

Default 0
rules[].​notAppliedRulePageCountintegerrequired

Number of pages with at least 1 rule not applied

Default 0
rules[].​ruleSnapshotIdinteger(int64)required
rules[].​originalRuleIdinteger(int64)

Rule ID

Example: 12
rules[].​ruleConfigExistsboolean

If false, the rule config doesn't exist anymore

rules[].​namestringrequired

Rule name

rules[].​tagsArray of objectsrequired

List of tags checked in the rule

rules[].​tags[].​tagIdintegerrequired

Tag ID

rules[].​tags[].​tagNamestringrequired

Tag name

rules[].​tags[].​tagCategoryIdintegerrequired

Tag category ID

rules[].​tags[].​tagCategoryNamestringrequired

Name of a category of a tag

rules[].​hasEmailNotificationbooleanrequired
rules[].​emailRecipientsArray of strings(email)required
Response
application/json
{
  "rules": [
    { … }
  ]
}

Get rule details for specified rule within specified audit run

Request

POST /v3/web-audits/{auditId}/runs/{runId}/reports/rule-summary/rule-results/{ruleSnapshotId}
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
ruleSnapshotIdinteger(int64)required

Rule snapshot ID

Bodyapplication/json

Filters (page filtering supported only)

pageUrlobject
finalPageUrlobject
pageTitleobject
initialPageStatusCodeobject
finalPageStatusCodeobject
combinedPageStatusCodestring
  • broken - initial or final URL are broken,
  • good - initial URL is good or redirect and final URL is good
Enum"broken""good"
pageLoadTimeobject
pageSizeobject
redirectCountobject
hasBrokenLinksboolean
pageUrlMatchingAuditFilterConfigurationboolean
primaryTagsOnlyboolean

if true then return only rules/pages with primary tags else return all rules/pages

tagIdinteger

Tag ID

tagCategoryIdinteger

Tag category ID

tagVendorIdinteger

Tag vendor ID

tagAccountstring

Tag account

ruleStatusstring
Enum"failed""passed""not_applied"
pageStatusCodestringDeprecated

good - 2xx, redirects - 3xx, broken - all others

Enum"good""redirects""broken"
ruleFailuresOnlybooleanDeprecated

Use ruleStatus instead

curl -i -X POST \
  'https://api.observepoint.com/v3/web-audits/107239/runs/33010/reports/rule-summary/rule-results/{ruleSnapshotId}' \
  -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,
    "tagAccount": "string",
    "ruleFailuresOnly": true,
    "ruleStatus": "failed"
  }'

Responses

Rule Details by Page - single rule details

Bodyapplication/json
failedRulePageCountintegerrequired

Number of pages with at least 1 rule failed

Default 0
passedRulePageCountintegerrequired

Number of pages with at least 1 rule passed

Default 0
notAppliedRulePageCountintegerrequired

Number of pages with at least 1 rule not applied

Default 0
ruleSnapshotIdinteger(int64)required
originalRuleIdinteger(int64)

Rule ID

Example: 12
ruleConfigExistsboolean

If false, the rule config doesn't exist anymore

namestringrequired

Rule name

tagsArray of objectsrequired

List of tags checked in the rule

tags[].​tagIdinteger(int32)required

Tag ID

tags[].​tagNamestringrequired

Tag name

tags[].​tagCategoryIdinteger(int32)required

Tag category ID

tags[].​tagCategoryNamestringrequired

Name of a category of a tag

tags[].​failedRulePageCountintegerrequired

Number of pages with at least 1 rule failed

Default 0
tags[].​passedRulePageCountintegerrequired

Number of pages with at least 1 rule passed

Default 0
tags[].​notAppliedRulePageCountintegerrequired

Number of pages with at least 1 rule not applied

Default 0
tags[].​ruleTagSnapshotIdinteger(int64)required
tags[].​ruleSnapshotIdinteger(int64)required
tags[].​matchTypestring
Enum"Unknown""TagPresent""Equals""NotEqual""Contains""DoesNotContain""Regex""IsSet""NotSet""GreaterThanOrEquals"
tags[].​accountstring
tags[].​validationDescriptionstring
tags[].​clausestring
Enum"If""Then""Else"
tags[].​variablesArray of objects
tags[].​statusCodeobject
hasEmailNotificationbooleanrequired
emailRecipientsArray of strings(email)required
pageFiltersArray of objectsrequired
pageFilters[].​failedRulePageCountintegerrequired

Number of pages with at least 1 rule failed

Default 0
pageFilters[].​passedRulePageCountintegerrequired

Number of pages with at least 1 rule passed

Default 0
pageFilters[].​notAppliedRulePageCountintegerrequired

Number of pages with at least 1 rule not applied

Default 0
pageFilters[].​pageFilterSnapshotIdinteger(int64)required
pageFilters[].​ruleSnapshotIdinteger(int64)required
pageFilters[].​valuestring
pageFilters[].​typeinteger(int32)

1 - url, 2 - status code, 3 - final url, 4 - final status code

Enum1234
pageFilters[].​matchTypestring
Enum"Unknown""TagPresent""Equals""NotEqual""Contains""DoesNotContain""Regex""IsSet""NotSet""GreaterThanOrEquals"
Response
application/json
{
  "failedRulePageCount": 0,
  "passedRulePageCount": 0,
  "notAppliedRulePageCount": 0,
  "ruleSnapshotId": 0,
  "originalRuleId": 0,
  "ruleConfigExists": true,
  "name": "string",
  "tags": [
    { … }
  ],
  "hasEmailNotification": true,
  "emailRecipients": [
    "user@example.com"
  ],
  "pageFilters": [
    { … }
  ]
}

Get page rule results within specified audit run

Request

POST /v3/web-audits/{auditId}/runs/{runId}/reports/rule-summary/page-rule-results
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
Query
pageinteger>= 0

Page number, starts with 0

Default 0
sizeinteger[ 50 .. 1000 ]
Default 50
sortBystring
Enum"page_url""final_page_url""page_status_code""final_page_status_code""page_load_time""rule_failures"
sortDescboolean

Controls sorting order

Default false
Bodyapplication/json

Filters

pageUrlobject
finalPageUrlobject
pageTitleobject
initialPageStatusCodeobject
finalPageStatusCodeobject
combinedPageStatusCodestring
  • broken - initial or final URL are broken,
  • good - initial URL is good or redirect and final URL is good
Enum"broken""good"
pageLoadTimeobject
pageSizeobject
redirectCountobject
hasBrokenLinksboolean
pageUrlMatchingAuditFilterConfigurationboolean
primaryTagsOnlyboolean

if true then return only rules/pages with primary tags else return all rules/pages

tagIdinteger

Tag ID

tagCategoryIdinteger

Tag category ID

tagVendorIdinteger

Tag vendor ID

tagAccountstring

Tag account

ruleStatusstring
Enum"failed""passed""not_applied"
ruleIdinteger(int64)

Rule ID

Example: 12
pageStatusCodestringDeprecated

good - 2xx, redirects - 3xx, broken - all others

Enum"good""redirects""broken"
ruleFailuresOnlybooleanDeprecated

Use ruleStatus instead

curl -i -X POST \
  'https://api.observepoint.com/v3/web-audits/107239/runs/33010/reports/rule-summary/page-rule-results?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,
    "tagAccount": "string",
    "ruleFailuresOnly": true,
    "ruleStatus": "failed",
    "ruleId": 12
  }'

Responses

Pages list with rule failures (when no specific rule condition/outcome selected)

Bodyapplication/json
metadataobjectrequired

Common metadata for iterable

metadata.​paginationobjectrequired
metadata.​pagination.​totalCountintegerrequired

Total number of items available from all result pages combined

metadata.​pagination.​totalPageCountintegerrequired

Total number of pages available

metadata.​pagination.​pageSizeintegerrequired

Page size - number of items per result page configured by size query parameter or default page size

metadata.​pagination.​currentPageSizeintegerrequired

Number of items in current result page

metadata.​pagination.​currentPageNumberintegerrequired

Current page number/ordinal

pagesArray of objectsrequired
pages[].​pageIdstringrequired
Example: "f9d32cc7cc2046d6decb145a80289287f5226323"
pages[].​pageUrlstring(url)required
Example: "https://example.com/about"
pages[].​pageLoadTimeintegerrequired

Time page took to load, in milliseconds

pages[].​pageStatusCodeintegerrequired

Page HTTP status code

pages[].​finalPageUrlstring(url)
Example: "https://example.com/about"
pages[].​finalPageStatusCodeinteger

Page HTTP status code

pages[].​ruleFailureCountintegerrequired

Number of rules failed on the page

Response
application/json
{
  "metadata": {
    "pagination": { … }
  },
  "pages": [
    { … }
  ]
}

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