Skip to content
/Alerts

V3 API

This section documents the V3 API endpoints that provide access to comprehensive audit and journey data from ObservePoint. Use these endpoints to retrieve detailed reports, export data, manage alerts, configure scans and privacy settings, and analyze web performance metrics from your ObservePoint scans.

Download OpenAPI description
combined.openapi.json
combined.openapi.yaml
Overview
URL
https://www.observepoint.com/contact-us
Languages
Servers
ObservePoint Production API
https://api.observepoint.com

Alert Summary Report

Alert Summary report endpoints

Operations

Audit Summary Report

Audit Summary report endpoints

Operations

Browser Logs Report

Browser Logs report endpoints

Operations

File Changes Report

File changes report endpoints

Operations

Page Details Report

Detailed information about specific pages including tags, cookies, request logs, and console logs

Operations

Page Summary Report

Page Summary report endpoints

Operations

Request Privacy Report

Request Privacy report endpoints

Operations

Rule Summary Report

Rule Summary report endpoints

Operations

Tag Duplicates and Multiples Report

Tag Duplicates and Multiples report endpoints

Operations

Tag Health Report

Tag Health report endpoints

Operations

Tag Inventory Report

Tag Inventory report endpoints

Operations

Tag Privacy Report

Tag privacy report endpoints

Operations

Variable Inventory Report

Variable Inventory report endpoints

Operations

Audit Run Data

Retrieve audit run data including pages, cookies, geo-locations, network requests, JS variables and failures for web audit runs

Operations

Account Usage Export

Export account usage data

Operations

Alert Export

Export alert data

Operations

Audit Run Export

Export audit run data

Operations

Exports Center

Access requested exports status/information

Operations

Manual Journey Run Export

Export manual journey run data

Operations

Scheduled Exports

Manage scheduled grid report data exports

Operations

Web Journey Run Export

Export web journey run data

Operations

Account's Triggered Alerts

Account-level triggered alerts

Operations

Account Usage Alerts

Alerts related to account usage

Operations

Alerts

Alert management and configuration

Operations

Create Alert

Request

POST /v3/alerts
Security
API_Key
Bodyapplication/jsonrequired

Alert definition

namestringnon-emptyrequired

User-defined name of the alert

labelsArray of integers(int64)

Passing null instead of this array while updating an entity will prevent API from changing associated labels

Example: [223]
metricTypestringrequired

Deprecated metric types:

  • ACCOUNT_USAGE_THIS_MONTH_AUDIT_PAGE_SCANNED_COUNT
  • ACCOUNT_USAGE_12_MONTH_AUDIT_PAGE_SCANNED_COUNT
  • ACCOUNT_USAGE_12_MONTH_WJ_RUN_COUNT
  • ACCOUNT_USAGE_THIS_MONTH_WJ_RUN_COUNT
  • ACCOUNT_USAGE_LAST_30_DAYS_LOGIN_USER_COUNT
  • PAGE_SUMMARY_FAILED_RULE_COUNT
Enum"ACCOUNT_USAGE_THIS_MONTH_AUDIT_PAGE_SCANNED_COUNT""ACCOUNT_USAGE_12_MONTH_AUDIT_PAGE_SCANNED_COUNT""ACCOUNT_USAGE_12_MONTH_WJ_RUN_COUNT""ACCOUNT_USAGE_THIS_MONTH_WJ_RUN_COUNT""ACCOUNT_USAGE_LAST_30_DAYS_LOGIN_USER_COUNT""ACCOUNT_USAGE_V2_THIS_MONTH_AUDIT_PAGE_USAGE_PERCENTAGE""ACCOUNT_USAGE_V2_CURRENT_TERM_PAGE_USAGE_PERCENTAGE""ACCOUNT_USAGE_V2_CURRENT_TERM_WJ_RUN_USAGE_PERCENTAGE""ACCOUNT_USAGE_V2_THIS_MONTH_WJ_RUN_USAGE_PERCENTAGE""ACCOUNT_USAGE_V2_LAST_30_DAYS_LOGIN_USER_COUNT"
metricChangeTypestring

Behaviour per type:

  • VALUE_CHANGE: current - previous
  • VALUE_CHANGE_ABS: ABS(current - previous)
  • RELATIVE_VALUE_CHANGE: 100% * (current - previous) / previous
  • RELATIVE_VALUE_CHANGE: ABS(100% * (current - previous) / previous)

Composite metric change operators shown on ObservePoint UI should be defined as described below:

  • Changes by (∆) = VALUE_CHANGE_ABS + GREATER_OR_EQUAL(positive number)
  • Increases by (+) = VALUE_CHANGE + GREATER_OR_EQUAL(positive number)
  • Decreases by (-) = VALUE_CHANGE + LESS_OR_EQUAL(negative number)
  • Any change = VALUE_CHANGE_ABS (or VALUE_CHANGE) + NOT_EQUAL(0)
  • Changes by (∆ %) = RELATIVE_CHANGE_ABS + GREATER_OR_EQUAL(positive number)
  • Increases by (+%) = RELATIVE_CHANGE + GREATER_OR_EQUAL(positive number)
  • Decreases by (-%) = RELATIVE_CHANGE + LESS_OR_EQUAL(negative number)
Enum"VALUE_CHANGE""VALUE_CHANGE_ABS""RELATIVE_VALUE_CHANGE""RELATIVE_VALUE_CHANGE_ABS"
targetValueComparatorobjectrequired

Subtypes: - AlertMetricSpecificValueComparator - AlertMetricValueInRangeComparator - AlertMetricValueNotInRangeComparator

targetValueComparator.​operatorstringrequired
Enum"GREATER""GREATER_OR_EQUAL""EQUAL""NOT_EQUAL""LESS_OR_EQUAL""LESS""BETWEEN""NOT_BETWEEN"
Discriminator
targetValueComparator.​targetValuenumber(float)required
filtersV0objectrequired

Filters to be applied before computing the alert. Exact type depends on metricType, see mapping in AlertMetricTypeToFilterMapping

emailsArray of strings(email)

List of email addresses that receive notifications when alert triggers. Will be replaced with Notification Profiles

Example: ["user@example.com"]
customAlertMessagestring
notificationPolicystring

Behaviour per type:

  • WHEN_NEWLY_TRIGGERED: (default) send alert when goes from "ok" to "triggered" (resets when no longer triggered)
  • ALWAYS_WHEN_TRIGGERED: send alert notification each time it is triggered per run
Enum"WHEN_NEWLY_TRIGGERED""ALWAYS_WHEN_TRIGGERED"
isDefaultForNewDataSourcesboolean

Makes this alert selected by default in data-source (audit/WJ) creation UI. This is a user-specific flag.

assignmentsArray of objects

Passing null instead of this array while updating an alert will prevent API from changing its assignments.
To pass only updates of assignments (additions/removals) for existing alert use PATCH /v3/alerts/{alertId}/target-items endpoint

skipSendingAlertSharedWithYouEmailboolean

When TRUE, "Alert shared with you" email will NOT be sent to newly added email addresses. When NOT specified or FALSE, it will be sent.

curl -i -X POST \
  https://api.observepoint.com/v3/alerts \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "labels": [
      223
    ],
    "metricType": "ACCOUNT_USAGE_THIS_MONTH_AUDIT_PAGE_SCANNED_COUNT",
    "metricChangeType": "VALUE_CHANGE",
    "targetValueComparator": {
      "operator": "GREATER"
    },
    "filtersV0": {},
    "emails": [
      "user@example.com"
    ],
    "customAlertMessage": "string",
    "notificationPolicy": "WHEN_NEWLY_TRIGGERED",
    "isDefaultForNewDataSources": true,
    "assignments": [
      {
        "itemType": "AUDIT",
        "itemId": 0
      }
    ],
    "skipSendingAlertSharedWithYouEmail": true
  }'

Responses

created successfully

Bodyapplication/json
idinteger(int64)
Response
application/json
{
  "id": 0
}

Get specific Alert by ID

Request

GET /v3/alerts/{alertId}
Security
API_Key
Path
alertIdinteger(int64)required
curl -i -X GET \
  'https://api.observepoint.com/v3/alerts/{alertId}' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

alert definition

Bodyapplication/json
namestringnon-emptyrequired

User-defined name of the alert

metricTypestringrequired

Deprecated metric types:

  • ACCOUNT_USAGE_THIS_MONTH_AUDIT_PAGE_SCANNED_COUNT
  • ACCOUNT_USAGE_12_MONTH_AUDIT_PAGE_SCANNED_COUNT
  • ACCOUNT_USAGE_12_MONTH_WJ_RUN_COUNT
  • ACCOUNT_USAGE_THIS_MONTH_WJ_RUN_COUNT
  • ACCOUNT_USAGE_LAST_30_DAYS_LOGIN_USER_COUNT
  • PAGE_SUMMARY_FAILED_RULE_COUNT
Enum"ACCOUNT_USAGE_THIS_MONTH_AUDIT_PAGE_SCANNED_COUNT""ACCOUNT_USAGE_12_MONTH_AUDIT_PAGE_SCANNED_COUNT""ACCOUNT_USAGE_12_MONTH_WJ_RUN_COUNT""ACCOUNT_USAGE_THIS_MONTH_WJ_RUN_COUNT""ACCOUNT_USAGE_LAST_30_DAYS_LOGIN_USER_COUNT""ACCOUNT_USAGE_V2_THIS_MONTH_AUDIT_PAGE_USAGE_PERCENTAGE""ACCOUNT_USAGE_V2_CURRENT_TERM_PAGE_USAGE_PERCENTAGE""ACCOUNT_USAGE_V2_CURRENT_TERM_WJ_RUN_USAGE_PERCENTAGE""ACCOUNT_USAGE_V2_THIS_MONTH_WJ_RUN_USAGE_PERCENTAGE""ACCOUNT_USAGE_V2_LAST_30_DAYS_LOGIN_USER_COUNT"
metricChangeTypestring

Behaviour per type:

  • VALUE_CHANGE: current - previous
  • VALUE_CHANGE_ABS: ABS(current - previous)
  • RELATIVE_VALUE_CHANGE: 100% * (current - previous) / previous
  • RELATIVE_VALUE_CHANGE: ABS(100% * (current - previous) / previous)

Composite metric change operators shown on ObservePoint UI should be defined as described below:

  • Changes by (∆) = VALUE_CHANGE_ABS + GREATER_OR_EQUAL(positive number)
  • Increases by (+) = VALUE_CHANGE + GREATER_OR_EQUAL(positive number)
  • Decreases by (-) = VALUE_CHANGE + LESS_OR_EQUAL(negative number)
  • Any change = VALUE_CHANGE_ABS (or VALUE_CHANGE) + NOT_EQUAL(0)
  • Changes by (∆ %) = RELATIVE_CHANGE_ABS + GREATER_OR_EQUAL(positive number)
  • Increases by (+%) = RELATIVE_CHANGE + GREATER_OR_EQUAL(positive number)
  • Decreases by (-%) = RELATIVE_CHANGE + LESS_OR_EQUAL(negative number)
Enum"VALUE_CHANGE""VALUE_CHANGE_ABS""RELATIVE_VALUE_CHANGE""RELATIVE_VALUE_CHANGE_ABS"
targetValueComparatorobjectrequired

Subtypes: - AlertMetricSpecificValueComparator - AlertMetricValueInRangeComparator - AlertMetricValueNotInRangeComparator

targetValueComparator.​operatorstringrequired
Enum"GREATER""GREATER_OR_EQUAL""EQUAL""NOT_EQUAL""LESS_OR_EQUAL""LESS""BETWEEN""NOT_BETWEEN"
Discriminator
targetValueComparator.​targetValuenumber(float)required
filtersV0objectrequired

Filters to be applied before computing the alert. Exact type depends on metricType, see mapping in AlertMetricTypeToFilterMapping

idinteger(int64)required
labelsArray of integers(int64)>= 0 itemsrequired
Example: [223]
emailsArray of strings(email)>= 0 itemsrequired

List of email addresses that receive notifications when alert triggers. Will be replaced with Notification Profiles

Example: ["user@example.com"]
customAlertMessagestring
notificationPolicystringrequired

Behaviour per type:

  • WHEN_NEWLY_TRIGGERED: (default) send alert when goes from "ok" to "triggered" (resets when no longer triggered)
  • ALWAYS_WHEN_TRIGGERED: send alert notification each time it is triggered per run
Enum"WHEN_NEWLY_TRIGGERED""ALWAYS_WHEN_TRIGGERED"
isDefaultForNewDataSourcesbooleanrequired

Makes this alert selected by default in data-source (audit/WJ) creation UI. This is a user-specific flag.

Response
application/json
{
  "name": "string",
  "metricType": "ACCOUNT_USAGE_THIS_MONTH_AUDIT_PAGE_SCANNED_COUNT",
  "metricChangeType": "VALUE_CHANGE",
  "targetValueComparator": {
    "operator": "GREATER"
  },
  "filtersV0": {},
  "id": 0,
  "labels": [
    223
  ],
  "emails": [
    "user@example.com"
  ],
  "customAlertMessage": "string",
  "notificationPolicy": "WHEN_NEWLY_TRIGGERED",
  "isDefaultForNewDataSources": true
}

Update specific Alert

Request

PUT /v3/alerts/{alertId}
Security
API_Key
Path
alertIdinteger(int64)required
Bodyapplication/json
namestringnon-emptyrequired

User-defined name of the alert

labelsArray of integers(int64)

Passing null instead of this array while updating an entity will prevent API from changing associated labels

Example: [223]
metricTypestringrequired

Deprecated metric types:

  • ACCOUNT_USAGE_THIS_MONTH_AUDIT_PAGE_SCANNED_COUNT
  • ACCOUNT_USAGE_12_MONTH_AUDIT_PAGE_SCANNED_COUNT
  • ACCOUNT_USAGE_12_MONTH_WJ_RUN_COUNT
  • ACCOUNT_USAGE_THIS_MONTH_WJ_RUN_COUNT
  • ACCOUNT_USAGE_LAST_30_DAYS_LOGIN_USER_COUNT
  • PAGE_SUMMARY_FAILED_RULE_COUNT
Enum"ACCOUNT_USAGE_THIS_MONTH_AUDIT_PAGE_SCANNED_COUNT""ACCOUNT_USAGE_12_MONTH_AUDIT_PAGE_SCANNED_COUNT""ACCOUNT_USAGE_12_MONTH_WJ_RUN_COUNT""ACCOUNT_USAGE_THIS_MONTH_WJ_RUN_COUNT""ACCOUNT_USAGE_LAST_30_DAYS_LOGIN_USER_COUNT""ACCOUNT_USAGE_V2_THIS_MONTH_AUDIT_PAGE_USAGE_PERCENTAGE""ACCOUNT_USAGE_V2_CURRENT_TERM_PAGE_USAGE_PERCENTAGE""ACCOUNT_USAGE_V2_CURRENT_TERM_WJ_RUN_USAGE_PERCENTAGE""ACCOUNT_USAGE_V2_THIS_MONTH_WJ_RUN_USAGE_PERCENTAGE""ACCOUNT_USAGE_V2_LAST_30_DAYS_LOGIN_USER_COUNT"
metricChangeTypestring

Behaviour per type:

  • VALUE_CHANGE: current - previous
  • VALUE_CHANGE_ABS: ABS(current - previous)
  • RELATIVE_VALUE_CHANGE: 100% * (current - previous) / previous
  • RELATIVE_VALUE_CHANGE: ABS(100% * (current - previous) / previous)

Composite metric change operators shown on ObservePoint UI should be defined as described below:

  • Changes by (∆) = VALUE_CHANGE_ABS + GREATER_OR_EQUAL(positive number)
  • Increases by (+) = VALUE_CHANGE + GREATER_OR_EQUAL(positive number)
  • Decreases by (-) = VALUE_CHANGE + LESS_OR_EQUAL(negative number)
  • Any change = VALUE_CHANGE_ABS (or VALUE_CHANGE) + NOT_EQUAL(0)
  • Changes by (∆ %) = RELATIVE_CHANGE_ABS + GREATER_OR_EQUAL(positive number)
  • Increases by (+%) = RELATIVE_CHANGE + GREATER_OR_EQUAL(positive number)
  • Decreases by (-%) = RELATIVE_CHANGE + LESS_OR_EQUAL(negative number)
Enum"VALUE_CHANGE""VALUE_CHANGE_ABS""RELATIVE_VALUE_CHANGE""RELATIVE_VALUE_CHANGE_ABS"
targetValueComparatorobjectrequired

Subtypes: - AlertMetricSpecificValueComparator - AlertMetricValueInRangeComparator - AlertMetricValueNotInRangeComparator

targetValueComparator.​operatorstringrequired
Enum"GREATER""GREATER_OR_EQUAL""EQUAL""NOT_EQUAL""LESS_OR_EQUAL""LESS""BETWEEN""NOT_BETWEEN"
Discriminator
targetValueComparator.​targetValuenumber(float)required
filtersV0objectrequired

Filters to be applied before computing the alert. Exact type depends on metricType, see mapping in AlertMetricTypeToFilterMapping

emailsArray of strings(email)

List of email addresses that receive notifications when alert triggers. Will be replaced with Notification Profiles

Example: ["user@example.com"]
customAlertMessagestring
notificationPolicystring

Behaviour per type:

  • WHEN_NEWLY_TRIGGERED: (default) send alert when goes from "ok" to "triggered" (resets when no longer triggered)
  • ALWAYS_WHEN_TRIGGERED: send alert notification each time it is triggered per run
Enum"WHEN_NEWLY_TRIGGERED""ALWAYS_WHEN_TRIGGERED"
isDefaultForNewDataSourcesboolean

Makes this alert selected by default in data-source (audit/WJ) creation UI. This is a user-specific flag.

assignmentsArray of objects

Passing null instead of this array while updating an alert will prevent API from changing its assignments.
To pass only updates of assignments (additions/removals) for existing alert use PATCH /v3/alerts/{alertId}/target-items endpoint

skipSendingAlertSharedWithYouEmailboolean

When TRUE, "Alert shared with you" email will NOT be sent to newly added email addresses. When NOT specified or FALSE, it will be sent.

curl -i -X PUT \
  'https://api.observepoint.com/v3/alerts/{alertId}' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "labels": [
      223
    ],
    "metricType": "ACCOUNT_USAGE_THIS_MONTH_AUDIT_PAGE_SCANNED_COUNT",
    "metricChangeType": "VALUE_CHANGE",
    "targetValueComparator": {
      "operator": "GREATER"
    },
    "filtersV0": {},
    "emails": [
      "user@example.com"
    ],
    "customAlertMessage": "string",
    "notificationPolicy": "WHEN_NEWLY_TRIGGERED",
    "isDefaultForNewDataSources": true,
    "assignments": [
      {
        "itemType": "AUDIT",
        "itemId": 0
      }
    ],
    "skipSendingAlertSharedWithYouEmail": true
  }'

Responses

updated successfully

Response
No content

Email Inbox Message Alerts

Email inbox message alerts

Operations

Account Usage

Account usage data

Operations

Email Inbox Configuration

APIs for managing email inbox configurations and setting

Operations

Email Inbox Messages

Get Email Inbox message details

Operations

Email Inboxes

APIs for getting email messages and results from email inboxes

Operations

Action Set Action Rules

APIs for managing Action Set Action Rules

Operations

Action Set Actions

APIs for managing Action Set Actions

Operations

Action Sets

APIs for managing Action Sets

Operations

Audit Actions

APIs for managing audit actions

Operations

Audit Blocking Config

APIs for managing audit request blocking configuration

Operations

Audit Login Actions

APIs for managing audit login actions

Operations

Audits Management

APIs for managing audits

Operations

Custom Headers

APIs for managing custom HTTP header groups

Operations

Data Sources

APIs for managing Data Sources

Operations

Geo Locations

APIs for geo locations

Operations

Notification Center

Find and manage email subscriptions

Operations

Remote File Mappings

APIs for managing Remote File Mappings

Operations

Rules

APIs for managing rules

Operations

Schedules

APIs for item schedules and calendars

Operations

Site Censuses

APIs for managing Site Census

Operations

User Events

APIs for managing User Events

Operations

Web Journey Blocking Config

APIs for managing web journey request blocking configuration

Operations

Web Journey Custom Headers

APIs for managing web journey custom headers

Operations

Web Journeys Management

APIs for managing Web Journeys

Operations