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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
ObservePoint

ObservePoint Alerts API

Alert management and configuration

Documentation Provider Profile APIs.io OpenAPI GitHub

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

This API exposes 11 operations across 9 paths, and defines 41 schemas. It is described by OpenAPI 3.2.0.

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

11 operations 9 paths 41 schemas 1 DELETE2 GET2 PATCH4 POST2 PUT

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
Contact
Observepoint
Resource Areas
1

Authentication & Security 1

ObservePoint 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 11

Across 9 paths, the API surfaces 11 operations — 1 DELETE, 2 GET, 2 PATCH, 4 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

alerts 11

Alert management and configuration

POST
/v3/alerts
Create Alert
createAlert body → 201400401403
GET
/v3/alerts/{alertId}
Get specific Alert by ID
getAlertById 1 param → 200401403404
PUT
/v3/alerts/{alertId}
Update specific Alert
updateAlertById 1 param body → 204400401403404
DELETE
/v3/alerts/{alertId}
Delete specific Alert
deleteAlertById 1 param → 204401403404
PUT
/v3/alerts/{alertId}/labels
Update labels for an Alert
updateAlertLabels 1 param body → 204400401403404
POST
/v3/alerts/library
Get Alerts Library items
getAlertsForLibrary 4 params body → 200401403404
GET
/v3/alerts/metrics/{metricType}
Get Alerts by metric
getAlertsByMetric 5 params → 200401403404
POST
/v3/alerts/target-items/{itemType}/search
Search target items (data sources - audits, journeys etc) that may have specified Alert assigned or not assigned
searchTargetItemsForAlert 5 params body → 200400401404
PATCH
/v3/alerts/{alertId}/target-items
Update target items (data sources) that have specified Alert assigned
updateTargetItemsOfAlert 1 param body → 204400401403404
POST
/v3/alerts/search/assignments
Search Alerts for assigning them to other items (audits, WJs etc)
searchAlertsForAssignment 4 params body → 200400401404
PATCH
/v3/alerts/assignments/{itemType}/{itemId}
Update Alerts assigned to specified item (audit, journey etc)
updateAlertsAssignedToItem 2 params body → 204400401403404

Schemas 41

The contract defines 41 schemas that model the data the API accepts and returns. The most detailed are CreateAlertRequestDTO (12 properties), SearchAlertAssignmentsRequestDTO (6 properties), GetAlertsLibraryRequestDTO (5 properties), PaginationMetadata (5 properties). Each schema is shown below with its type and property counts.

SearchAlertsForAssignmentResponseDTO
object
2 properties 2 required
GetAlertsLibraryRequestDTO
object
All filters are optional. All populated filters are combined via AND boolean operator
5 properties
AlertMetricValueComparator
object
Subtypes: - AlertMetricSpecificValueComparator - AlertMetricValueInRangeComparator - AlertMetricValueNotInRangeComparator
1 property 1 required
SearchAlertsForAssignmentSortColumn
string
Behaviour per type: - REPORTMETRIC: sort by name of data/report type corresponding to alert's metricType
GetAlertsLibraryResponseDTO
object
2 properties 2 required
FoldersFilter
array
non-empty array of folders with domains (subfolders), items from which will be included in response
CreateAlertRequestDTO
object
Alert is triggered when comparison holds: actual value
12 properties 4 required
AlertMetricValueComparisonOperatorEnum
string
GetAlertsByMetricSortColumn
string
CreateAlertResponseDTO
object
1 property
GetAlertsByMetricResponseDTO
object
2 properties 2 required
AlertNotificationPolicyEnum
string
Behaviour per type: - WHENNEWLYTRIGGERED: (default) send alert when goes from "ok" to "triggered" (resets when no longer triggered) - ALWAYSWHENTRIGGERED: send…
FolderId
integer
ID of a folder
AlertAssignmentUpdateOperationTypeEnum
string
Meaning by type: - ASSIGN: add (if not exist) or update (if already exists) alert assignment - UNASSIGN: remove alert assignment. Does nothing if assignment do…
EmailAddress
string
SearchAlertAssignmentsResponseDTO
object
2 properties 2 required
LabelId
integer
Label identifier
AlertId
integer
AlertAssignmentItem
object
2 properties 2 required
FoldersFilterItem
object
2 properties 1 required
AlertIsDefaultForNewDataSources
boolean
Makes this alert selected by default in data-source (audit/WJ) creation UI. This is a user-specific flag.
PaginationMetadata
object
5 properties 5 required
AlertAssignmentItemTypeEnum
string
AlertName
string
User-defined name of the alert
UpdateSpecificAlertAssignmentsRequestDTO
object
1 property 1 required
SearchAlertAssignmentsRequestDTO
object
Filters for searching for items that may have specific Alert assigned or not assigned. - when alertId is specified, isAssigned field in response object will be…
6 properties
AlertAssignmentsSortColumn
string
GetAlertsByMetricItem
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…
GetAlertDefinitionResponseDTO
AlertConfigTrait
object
Core parts of alert definition
5 properties 4 required
UpdateSpecificItemAlertsRequestDTO
object
1 property 1 required
AlertAssignmentItemId
integer
ID of the item that can have assigned Alert(s) onto it. See also AlertAssignmentTypeEnum
DomainId
integer
ID of a domain
CommonIterableResponseMetadata
object
Common metadata for iterable
1 property 1 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…
UserId
integer
ID of a user
SearchAlertsForAssignmentRequestDTO
object
All included filters are optional. All populated filters are combined via AND boolean operator
4 properties
GetAlertsLibrarySortColumn
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

observepoint-alerts-api-openapi.yml Raw ↑

Other APIs ObservePoint publishes across the network.

ObservePoint Account API
AE Profile APIs.io
ObservePoint Account Triggered Alerts API
AE Profile APIs.io
ObservePoint Account Usage Alerts API
AE Profile APIs.io
ObservePoint Account Usage Export API
AE Profile APIs.io
ObservePoint Account Usage V2 API
AE Profile APIs.io
ObservePoint Action Set Action Rules API
AE Profile APIs.io
ObservePoint Action Set Actions API
AE Profile APIs.io
ObservePoint Action Sets API
AE Profile APIs.io
ObservePoint Alert Export API
AE Profile APIs.io
ObservePoint Alert Summary Report API
AE Profile APIs.io
ObservePoint Audit Actions API
AE Profile APIs.io
ObservePoint Audit Blocking Config API
AE Profile APIs.io
#Alerts
← Back to O APIs
API Details
ID
observepoint:observepoint-alerts-api
Base URL
https://api.observepoint.com
Docs
https://api-docs.observepoint.com/sections/v3-index
Provider
ObservePoint
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=observepoint-alerts-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/observepoint-alerts-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

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