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

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.

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

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

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

hasEmailNotificationbooleanrequired
emailRecipientsArray of strings, (email)required
pageFiltersArray of objectsrequired
Response
{
  "failedRulePageCount": 0,
  "passedRulePageCount": 0,
  "notAppliedRulePageCount": 0,
  "ruleSnapshotId": 0,
  "originalRuleId": 0,
  "ruleConfigExists": true,
  "name": "string",
  "tags": [
    { … }
  ],
  "hasEmailNotification": true,
  "emailRecipients": [
    "user@example.com"
  ],
  "pageFilters": [
    { … }
  ]
}