Skip to content
v3 API
/
Rule Summary Report
/
Get rule results page count trend values for specified audit run relative to current day

V3 API

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.

Download OpenAPI description
REPORTING-API.openapi.json
REPORTING-API.openapi.yaml
Overview
URL

https://www.observepoint.com/contact-us

Languages
Servers
ObservePoint Production API

https://api.observepoint.com/

Audit Run Data

Retrieve audit run data including pages, cookies, geo-locations, network requests, JS variables and failures for web audit runs

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

Audit Summary Report

Audit Summary report endpoints

Operations

Alert Summary Report

Alert Summary 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)
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": 0
  }'

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": [
    { … }
  ]
}

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

Request

GET /v3/web-audits/{auditId}/reports/rule-summary/trends/page-count
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/page-count?days=0' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Audit rule results page count 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[].​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
Response
application/json
{
  "runs": [
    { … }
  ]
}

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

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)
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": 0
  }'

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

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"
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)

ID of an original rule snapshot has been taken from. May not be available if the rule doesn't exist anymore

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

Number of results page of an endpoint with paginated results

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

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)
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": 0
  }'

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": [
    { … }
  ]
}

Get specific rule page results within specified audit run

Request

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

Query
pageinteger>= 0

Number of results page of an endpoint with paginated results

Default 0
sizeinteger[ 50 .. 1000 ]
Default 50
sortBystring
Enum"page_url""final_page_url""page_status_code""final_page_status_code""page_load_time"
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

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"
ruleFilterobject

Optionally filters by a specific component within the rule's logic (e.g., a tag or variable condition). When used with filterType = tag_filter or tag_variable_filter, it overrides the default behavior of the ruleResultType filter, applying it to this specific component's outcome

ruleResultTypestring
Enum"passed""failed""not_applied""broken"
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/{ruleSnapshotId}?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",
    "ruleFilter": {
      "filterType": "page_filter"
    },
    "ruleResultType": "passed"
  }'

Responses

Pages list with rule condition details (when specific rule condition/outcome is 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[].​conditionResultobjectrequired

Only tag variable condition has parent - tag condition

pages[].​conditionResult.​idinteger(int64)required

condition snapshot ID. One of: RulePageFilterSnapshotId, RuleTagSnapshotId, RuleTagVariableSnapshotId

pages[].​conditionResult.​idTypestringrequired
pages[].​conditionResult.​parentIdinteger(int64)
pages[].​conditionResult.​parentTypestring
pages[].​conditionResult.​namestringrequired
pages[].​conditionResult.​matcherstringrequired
pages[].​conditionResult.​actualstring
pages[].​conditionResult.​expectedobjectrequired

The rule condition expected values

pages[].​conditionResult.​expected.​expectedArray of stringsrequired
pages[].​conditionResult.​expected.​namestring
pages[].​conditionResult.​expected.​selectorTypestring
Enum"String""UrlParameter""DataLayer""Tag""FinalUrlParam""Empty"
Response
application/json
{
  "metadata": {
    "pagination": { … }
  },
  "pages": [
    { … }
  ]
}

Tag Inventory Report

Tag Inventory report endpoints

Operations

Tag Health Report

Tag Health report endpoints

Operations

Tag Duplicates and Multiples Report

Tag Duplicates and Multiples report endpoints

Operations

Variable Inventory Report

Variable Inventory report endpoints

Operations

Browser Logs Report

Browser Logs report endpoints

Operations

File Changes Report

File changes report endpoints

Operations

Tag Privacy Report

Tag privacy report endpoints

Operations

Request Privacy Report

Request Privacy report endpoints

Operations

Exports Center

Access requested exports status/information

Operations

Scheduled Exports

Manage scheduled grid report data exports

Operations

Audit Run Export

Export audit run data

Operations

Web Journey Run Export

Export web journey run data

Operations

Manual Journey Run Export

Export manual journey run data

Operations

Alerts

Alert management and configuration

Operations

Account's Triggered Alerts

Account-level triggered alerts

Operations

Alert Export

Export alert data

Operations

Account Usage

Account usage data

Operations

Account Usage Alerts

Alerts related to account usage

Operations

Account Usage Export

Export account usage data

Operations

Notification Center

Find and manage email subscriptions

Operations

Email Inbox Messages

Get Email Inbox message details

Operations

Email Inbox Message Alerts

Email inbox message alerts

Operations