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 Alert Summary Report API

Alert Summary report endpoints

ObservePoint Alert 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 alert-summary-report. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

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

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

3 operations 3 paths 28 schemas 2 GET1 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 Alert 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 3

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

alert-summary-report 3

Alert Summary report endpoints

GET
/v3/web-audits/{auditId}/runs/{runId}/reports/alert-summary/overview
Get Alerts statuses overview for specified audit run
getAuditRunAlertSummaryAlertsOverview 2 params → 200400401404
POST
/v3/web-audits/{auditId}/runs/{runId}/reports/alert-summary/alerts
Get Alert Summary alerts table data for specified audit run
getAuditRunAlertSummaryAlerts 6 params body → 200400401404
GET
/v3/web-audits/{auditId}/runs/{runId}/reports/alert-summary/alerts/{alertId}
Get specific alert data (config + result) for specified audit run
getAuditRunAlertSummaryAlertById 3 params → 200400401404

Schemas 28

The contract defines 28 schemas that model the data the API accepts and returns. The most detailed are AuditRun_AuditSummary_AlertsResponseItem (5 properties), AlertConfigTrait (5 properties), PaginationMetadata (5 properties), AlertResultDetails (4 properties). Each schema is shown below with its type and property counts.

AlertMetricValueComparator
object
Subtypes: - AlertMetricSpecificValueComparator - AlertMetricValueInRangeComparator - AlertMetricValueNotInRangeComparator
1 property 1 required
AuditRun_AuditSummary_AlertsResponseItemConfig
AuditId
integer
AuditRun_AlertSummary_AlertsOverviewResponseDTO
object
1 property 1 required
AuditRun_AuditSummary_AlertsItem_HistoryItem
AuditRun_AuditSummary_SpecificAlertResponseDTO
object
4 properties 4 required
ItemRunTrendsItemTrait
object
2 properties 2 required
AlertMetricValueComparisonOperatorEnum
string
AuditRun_AuditSummary_AlertResult
AuditRun_AuditSummary_AlertsResponseItem
object
5 properties 5 required
AlertId
integer
AlertResultsHistoryArray
array
Returns up to 20 runs with alert results
PaginationMetadata
object
5 properties 5 required
AlertResultDetails
object
4 properties 1 required
AlertName
string
User-defined name of the alert
AuditRun_AlertSummary_SummaryRequestDTO
object
Request body with filters for Alert Summary report
4 properties
AuditRun_AuditSummary_AlertsSortColumn
string
RunId
integer
AuditRun_AuditSummary_AlertsResponseDTO
object
2 properties 2 required
AlertConfigExistsFlag
boolean
when true then alert config exists and can be edited, otherwise it is deleted
ErrorModel
object
4 properties
AlertMetricChangeTypeEnum
string
Behaviour per type: - VALUECHANGE: current - previous - VALUECHANGEABS: ABS(current - previous) - RELATIVEVALUECHANGE: 100% (current - previous) / previous - R…
AlertMetricTypeEnum
string
Deprecated metric types: - ACCOUNTUSAGETHISMONTHAUDITPAGESCANNEDCOUNT - ACCOUNTUSAGE12MONTHAUDITPAGESCANNEDCOUNT - ACCOUNTUSAGE12MONTHWJRUNCOUNT - ACCOUNTUSAGE…
CommonIterableResponseMetadata
object
Common metadata for iterable
1 property 1 required
AlertResultStatusEnum
string
All statuses except TRIGGERED and NOTTRIGGERED mean that alert/metric could not be computed. Statuses: - UNKNOWNERROR: data retrieval or alert computation fail…
AlertConfigTrait
object
Core parts of alert definition
5 properties 4 required
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…
AlertResultSimplifiedStatusEnum
string
Simplified version of /components/schemas/AlertResultStatusEnum for UI filters

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

observepoint-alert-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 Alerts API
ObservePoint Audit Actions API
ObservePoint Audit Blocking Config API
Where this information came from

This is an independent, third-party profile of ObservePoint Alert 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.