Skip to content
/Rule Summary Report

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 rule summary for specified audit run

Request

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

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.

pageSizeobject

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.

redirectCountobject

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.

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 \
  -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

Total Pages + Rules Applied + Rule Instances by Status + Pages by Rule Status

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
failedRuleCountintegerrequired

Number of rules failed on at least 1 page

Default 0
passedRuleCountintegerrequired

Number of rules passed on at least 1 page

Default 0
notAppliedRuleCountintegerrequired

Number of rules not applied on at least 1 page

Default 0
totalPageCountintegerrequired

Total number of pages audited

filteredPageCountintegerrequired

Number of pages passing all applied filters

totalRuleCountintegerrequired

Total number of rules applied to an audit run

filteredRuleCountintegerrequired

Number of rules passing all applied filters

totalRuleFailureCountintegerrequired

Total number of rule failures (counted for every rule on every page)

filteredRuleFailureCountintegerrequired

Number of rule failures (counted for every rule on every page) passing all applied filters

Response
application/json
{
  "failedRulePageCount": 0,
  "passedRulePageCount": 0,
  "notAppliedRulePageCount": 0,
  "failedRuleCount": 0,
  "passedRuleCount": 0,
  "notAppliedRuleCount": 0,
  "totalPageCount": 0,
  "filteredPageCount": 0,
  "totalRuleCount": 0,
  "filteredRuleCount": 0,
  "totalRuleFailureCount": 0,
  "filteredRuleFailureCount": 0
}

Get rule status trends for specified audit run

Request

GET /v3/web-audits/{auditId}/runs/{runId}/reports/rule-summary/trends
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
curl -i -X GET \
  https://api.observepoint.com/v3/web-audits/107239/runs/33010/reports/rule-summary/trends \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Audit rule results trends overview (a.k.a. trendlines a.k.a. sparklines) for both Rule Instances by Status + Pages by Rule Status

Bodyapplication/json
runsArray of objects<= 5 itemsrequired
runs[].​runIdinteger(int64)required
Example: 33010
runs[].​completedAtstring(date-time)required

Date-time in RFC3339 profile ISO 8601 format with the following additional restrictions:

  1. An uppercase T must separate the date and time portions.
  2. 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"
runs[].​failedRulePageCountintegerrequired

Number of pages with at least 1 rule failed

Default 0
runs[].​passedRulePageCountintegerrequired

Number of pages with at least 1 rule passed

Default 0
runs[].​notAppliedRulePageCountintegerrequired

Number of pages with at least 1 rule not applied

Default 0
runs[].​failedRuleCountintegerrequired

Number of rules failed on at least 1 page

Default 0
runs[].​passedRuleCountintegerrequired

Number of rules passed on at least 1 page

Default 0
runs[].​notAppliedRuleCountintegerrequired

Number of rules not applied on at least 1 page

Default 0
Response
application/json
{
  "runs": [
    { … }
  ]
}

Get rule results trend values for specified audit run relative to current day

Request

GET /v3/web-audits/{auditId}/reports/rule-summary/trends/rule-results
Security
API_Key
Path
auditIdinteger(int64)required

Unique identification number for web audit

Example: 107239
Query
daysintegerrequired

Number of days to get trend values for, relative to current time

curl -i -X GET \
  'https://api.observepoint.com/v3/web-audits/107239/reports/rule-summary/trends/rule-results?days=0' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Audit rule results trend values

Bodyapplication/json
runsArray of objectsrequired
runs[].​runIdinteger(int64)required
Example: 33010
runs[].​completedAtstring(date-time)required

Date-time in RFC3339 profile ISO 8601 format with the following additional restrictions:

  1. An uppercase T must separate the date and time portions.
  2. 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"
runs[].​failedRuleCountintegerrequired

Number of rules failed on at least 1 page

Default 0
runs[].​passedRuleCountintegerrequired

Number of rules passed on at least 1 page

Default 0
runs[].​notAppliedRuleCountintegerrequired

Number of rules not applied on at least 1 page

Default 0
Response
application/json
{
  "runs": [
    { … }
  ]
}

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