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 Account Triggered Alerts API

Account-level triggered alerts

ObservePoint Account Triggered Alerts API is one of 65 APIs that ObservePoint publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include account-triggered-alerts. 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 33 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 33 schemas 3 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 Account Triggered Alerts 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 — 3 POST. Each is listed below with its method, path, parameters, and response codes.

account-triggered-alerts 3

Account-level triggered alerts

POST
/v3/account-triggered-alerts/summary
Get summary for all triggered alerts for the account
getAccountTriggeredAlertsSummary body → 200400401404
POST
/v3/account-triggered-alerts/alerts
Get all triggered alerts for the account
getAccountTriggeredAlerts 4 params body → 200400401404
POST
/v3/account-triggered-alerts/alerts/{alertId}
Get information about specific alert from all triggered alerts for the account
getAccountTriggeredSpecificAlert 5 params body → 200400401404

Schemas 33

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

AccountTriggeredAlerts_AlertsDTO
object
2 properties 2 required
AlertMetricValueComparator
object
Subtypes: - AlertMetricSpecificValueComparator - AlertMetricValueInRangeComparator - AlertMetricValueNotInRangeComparator
1 property 1 required
FoldersFilter
array
non-empty array of folders with domains (subfolders), items from which will be included in response
AlertMetricValueComparisonOperatorEnum
string
FolderId
integer
ID of a folder
AlertRunDateRange
object
Should have from and/or to dates defined. from is inclusive and to is exclusive. to date should be after from date.
2 properties
AccountTriggeredAlertsSpecificAlertRequestDTO
object
5 properties
GetAccountTriggeredAlertsSortColumn
string
LabelId
integer
Label identifier
AlertId
integer
AccountTriggeredAlerts_Alert
FoldersFilterItem
object
2 properties 1 required
PaginationMetadata
object
5 properties 5 required
AlertResultDetails
object
4 properties 1 required
GetAccountTriggeredAlertSortColumn
string
PagesWithTriggeredAlerts
object
2 properties 2 required
AlertAssignmentItemTypeEnum
string
AlertName
string
User-defined name of the alert
AccountTriggeredAlertsRequestDTO
object
Request body with filters for Account Triggered Alerts
9 properties
RunId
integer
AlertConfigExistsFlag
boolean
when true then alert config exists and can be edited, otherwise it is deleted
AccountTriggeredAlerts_DataSourcesDTO
object
2 properties 2 required
ErrorModel
object
4 properties
AlertMetricTypeEnum
string
Deprecated metric types: - ACCOUNTUSAGETHISMONTHAUDITPAGESCANNEDCOUNT - ACCOUNTUSAGE12MONTHAUDITPAGESCANNEDCOUNT - ACCOUNTUSAGE12MONTHWJRUNCOUNT - ACCOUNTUSAGE…
AlertMetricChangeTypeEnum
string
Behaviour per type: - VALUECHANGE: current - previous - VALUECHANGEABS: ABS(current - previous) - RELATIVEVALUECHANGE: 100% (current - previous) / previous - R…
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…
AccountTriggeredAlerts_DataSource
DomainId
integer
ID of a domain
AlertAssignmentItemId
integer
ID of the item that can have assigned Alert(s) onto it. See also AlertAssignmentTypeEnum
AccountTriggeredAlerts_SummaryDTO
object
4 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

observepoint-account-triggered-alerts-api-openapi.yml Raw ↑

Other APIs ObservePoint publishes across the network.

ObservePoint Account 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
ObservePoint Audit Blocking Config API
Where this information came from

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