How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

ObservePoint Rule Summary Report API

Rule Summary report endpoints

ObservePoint Rule Summary Report API is one of 65 APIs that ObservePoint publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include rule-summary-report. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 8 operations across 8 paths, and defines 75 schemas. It is described by OpenAPI 3.2.0.

Requests are made against a single base URL, https://api.observepoint.com.

8 operations 8 paths 75 schemas 3 GET5 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
Base URL
https://api.observepoint.com
Authentication
API Key
Resource Areas
1

Authentication & Security 1

ObservePoint Rule Summary Report API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (API_Key).

  • API_Key — Use the Authorization header in your requests with ObservePoint API key as header value. Example: Authorization: abc123...def456

Paths & Operations 8

Across 8 paths, the API surfaces 8 operations — 3 GET, 5 POST. Each is listed below with its method, path, parameters, and response codes.

rule-summary-report 8

Rule Summary report endpoints

POST
/v3/web-audits/{auditId}/runs/{runId}/reports/rule-summary
Get rule summary for specified audit run
getAuditRunRuleResultsSummary 2 params body → 200400401404
GET
/v3/web-audits/{auditId}/runs/{runId}/reports/rule-summary/trends
Get rule status trends for specified audit run
getAuditRunRuleResultsTrends 2 params → 200401404
GET
/v3/web-audits/{auditId}/reports/rule-summary/trends/rule-results
Get rule results trend values for specified audit run relative to current day
getAuditRunRuleResultsTrend 2 params → 200401404
GET
/v3/web-audits/{auditId}/reports/rule-summary/trends/page-count
Get rule results page count trend values for specified audit run relative to current day
getAuditRunRuleResultsPageCountTrend 2 params → 200401404
POST
/v3/web-audits/{auditId}/runs/{runId}/reports/rule-summary/rule-results
Get all rules overview for specified audit run
getAuditRunAllRuleResultsOverview 2 params body → 200400401404
POST
/v3/web-audits/{auditId}/runs/{runId}/reports/rule-summary/rule-results/{ruleSnapshotId}
Get rule details for specified rule within specified audit run
getAuditRunSpecificRuleResults 3 params body → 200401404
POST
/v3/web-audits/{auditId}/runs/{runId}/reports/rule-summary/page-rule-results
Get page rule results within specified audit run
getAuditRunPageRuleResults 6 params body → 200400401404
POST
/v3/web-audits/{auditId}/runs/{runId}/reports/rule-summary/page-rule-results/{ruleSnapshotId}
Get specific rule page results within specified audit run
getAuditRunSpecificRulePageRuleResults 7 params body → 200400401404

Schemas 75

The contract defines 75 schemas that model the data the API accepts and returns. The most detailed are PageFiltersTrait (10 properties), AuditRun_RuleSummary_RuleConditionResult (8 properties), PaginationMetadata (5 properties), ErrorModel (4 properties). Each schema is shown below with its type and property counts.

PageStatusCode
integer
Page HTTP status code
ItemRunTrendsItemTrait
object
2 properties 2 required
TagId
integer
Tag ID
AuditRun_RuleSummary_SpecificRulePagesRequestDTO
Request to get pages list with rule condition details (when specific rule condition/outcome is selected)
PaginationMetadata
object
5 properties 5 required
PageFiltersTrait
object
Common trait for page filters
10 properties
AuditRunRuleCountTrait
object
Common trait for rule count per rule result type attributes
3 properties 3 required
AuditRun_RuleResultsSummaryDTO
Total Pages + Rules Applied + Rule Instances by Status + Pages by Rule Status
CombinedPageStatusCodeEnum
string
- broken - initial or final URL are broken, - good - initial URL is good or redirect and final URL is good
PageSizeFilter
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.
PageLoadTime
integer
Time page took to load, in milliseconds
CommonIterableResponseMetadata
object
Common metadata for iterable
1 property 1 required
TagCategoryId
integer
Tag category ID
AuditRun_RuleSummary_AllRules_PagesSortColumn
string
LongIntegerRangeFilterTrait
object
Common trait for long integer min max filter
2 properties
PageTitleFilter
object
2 properties 2 required
AuditRun_RuleSummary_PageRuleResultsDTO
object
Pages list with rule failures (when no specific rule condition/outcome selected)
2 properties 2 required
TagVendorId
integer
Tag vendor ID
AuditId
integer
AuditRunRuleResultsTrendItem
PageUrlFilter
object
3 properties 2 required
AuditRunPageCommonColumnsWithFinalValuesTrait
Trait for audit page with final URL and final status code
RuleTagVariableSnapshot
AuditRun_AllRuleResultsItem
RuleTagVariableSnapshotId
integer
AuditRun_RuleSummary_SpecificRulePageRuleResultsDTO
object
Pages list with rule condition details (when specific rule condition/outcome is selected) The ruleResultType filter applies to the specific condition outcome w…
2 properties 2 required
AuditRun_RuleSummary_RequestDTO
Request to get rule summary
AuditRunPageCommonColumnsTrait
Trait for audit page with common page properties
TagName
string
Tag name
ErrorModel
object
4 properties
TagCategoryName
string
Name of a category of a tag
IntegerFilter
object
2 properties 2 required
PageUrlFilterEnum
string
AuditRunRulePageCountTrait
object
Common trait for page count per rule result type attributes
3 properties 3 required
AuditRun_RuleSummary_BaseRequestTrait
object
Common request body with filters applicable to rule summary report If initialPageStatusCode and pageStatusCode filters provided, pageStatusCode will be ignored
PageId
string
AuditRunPageTrait
object
Common trait for audit page with mandatory page properties
2 properties 2 required
AuditRunRuleResultsPageCountTrendItem
PageFilterSnapshot
AuditRun_RuleSummary_RuleConditionResult
object
Only tag variable condition has parent - tag condition
8 properties 5 required
PageRedirectCountFilter
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.
AuditRun_RuleSummary_SpecificRule_PagesSortColumn
string
AuditRun_RuleResults_AllTrendsItem
RuleStatus
string
AuditRun_RuleSummary_SpecificRuleResultsRequestDTO
Request to get rule results list
AuditRun_RuleSummary_RuleResultsTrendDTO
object
Audit rule results trend values
1 property 1 required
RuleId
integer
Rule ID
AuditRun_RuleSummary_PageRuleResultsRuleFilterEnum
string
AuditRun_RuleSummary_SpecificRulePageRuleResultsItem
AuditRun_RuleSummary_SpecificRuleResultsDTO
Rule Details by Page - single rule details
AuditRun_RuleSummary_RuleResultEnum
string
DateAndTime
string
Date-time in [RFC3339 profile ISO 8601 format](https://www.ietf.org/rfc/rfc3339.txt) with the following additional restrictions: 1. An uppercase T must separat…
StringInclusionFilterTypeEnum
string
PageLoadTimeFilter
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.
AuditRun_RuleSummary_AllRuleResultsRequestDTO
Request to get all rules/pages results
AuditRun_RuleSummary_RuleResults_PageCountTrendDTO
object
Audit rule results page count trend values
1 property 1 required
IntegerFilterTypeEnum
string
StatusCodeValueType
string
RuleSnapshotId
integer
RulePageFilterSnapshotId
integer
IntegerRangeFilterTrait
object
Common trait for integer min max filter
2 properties
AuditRun_RuleSummary_PageRuleResultsItem
PageUrl
string
StatusCodeEnum
string
good - 2xx, redirects - 3xx, broken - all others
AuditRun_RuleSummary_RuleResults_AllTrendsDTO
object
Audit rule results trends overview (a.k.a. trendlines a.k.a. sparklines) for both Rule Instances by Status + Pages by Rule Status
1 property 1 required
RunId
integer
AuditRun_RuleSummary_PageRuleResultsRuleFilter
object
Optionally filters by a specific component within the rule's logic (e.g., a tag or variable condition). When used with filterType = tagfilter or tagvariablefil…
1 property 1 required
AuditRun_RuleSummary_AllRuleResultsOverviewDTO
object
Rule Details by Page - all rules overview
1 property 1 required
ConditionExpectedResult
object
The rule condition expected values
3 properties 1 required
MatchType
string
RuleTagStatusCode
object
3 properties 2 required
RuleTagSnapshot
TagAccount
string
Tag account
RuleTagSnapshotId
integer
TagInfoTrait
object
Common tag info
4 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

observepoint-rule-summary-report-api-openapi.yml Raw ↑

Other APIs ObservePoint publishes across the network.

ObservePoint Account API
ObservePoint Account Triggered Alerts API
ObservePoint Account Usage Alerts API
ObservePoint Account Usage Export API
ObservePoint Account Usage V2 API
ObservePoint Action Set Action Rules API
ObservePoint Action Set Actions API
ObservePoint Action Sets API
ObservePoint Alert Export API
ObservePoint Alert Summary Report API
ObservePoint Alerts API
ObservePoint Audit Actions API
Where this information came from

This is an independent, third-party profile of ObservePoint Rule Summary Report API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.