Skip to content
/Rule Summary Report

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.

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

POST
/v3/web-audits/{auditId}/runs/{runId}/reports/rule-summary
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,
      "filterValue": 0
    },
    "finalPageStatusCode": {
      "filterType": "specific",
      "negated": true,
      "filterValue": 0
    },
    "combinedPageStatusCode": "broken",
    "pageLoadTime": {
      "min": 0,
      "max": 0
    },
    "pageSize": {
      "min": 0,
      "max": 0
    },
    "redirectCount": {
      "min": 0,
      "max": 0
    },
    "hasBrokenLinks": 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
{
  "failedRulePageCount": 0,
  "passedRulePageCount": 0,
  "notAppliedRulePageCount": 0,
  "failedRuleCount": 0,
  "passedRuleCount": 0,
  "notAppliedRuleCount": 0,
  "totalPageCount": 0,
  "filteredPageCount": 0,
  "totalRuleCount": 0,
  "filteredRuleCount": 0,
  "totalRuleFailureCount": 0,
  "filteredRuleFailureCount": 0
}