Skip to content
v3 API/
/
Get page rule results wit...

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

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/page-rule-results
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,
      "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

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

Bodyapplication/json
metadataobjectrequired

Common metadata for iterable

pagesArray of objectsrequired
Response
{
  "metadata": {
    "pagination": { … }
  },
  "pages": [
    { … }
  ]
}