Skip to content
v3 API
/
Alerts
/
Search Alerts for assigning them to other items (audits, WJs etc)

V3 API

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

Download OpenAPI description
REPORTING-API.openapi.json
REPORTING-API.openapi.yaml
Overview
URL

https://www.observepoint.com/contact-us

Languages
Servers
ObservePoint Production API

https://api.observepoint.com/

Audit Run Data

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

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

Audit Summary Report

Audit Summary report endpoints

Operations

Alert Summary Report

Alert Summary report endpoints

Operations

Rule Summary Report

Rule Summary report endpoints

Operations

Tag Inventory Report

Tag Inventory report endpoints

Operations

Tag Health Report

Tag Health report endpoints

Operations

Tag Duplicates and Multiples Report

Tag Duplicates and Multiples report endpoints

Operations

Variable Inventory Report

Variable Inventory report endpoints

Operations

Browser Logs Report

Browser Logs report endpoints

Operations

File Changes Report

File changes report endpoints

Operations

Tag Privacy Report

Tag privacy report endpoints

Operations

Request Privacy Report

Request Privacy report endpoints

Operations

Exports Center

Access requested exports status/information

Operations

Scheduled Exports

Manage scheduled grid report data exports

Operations

Audit Run Export

Export audit run data

Operations

Web Journey Run Export

Export web journey run data

Operations

Manual Journey Run Export

Export manual journey run data

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

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": [
      0
    ],
    "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
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": [
    0
  ],
  "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

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": [
      0
    ],
    "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

Delete specific Alert

Request

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

Responses

deleted successfully

Response
No content

Update labels for an Alert

Request

PUT /v3/alerts/{alertId}/labels
Security
API_Key
Path
alertIdinteger(int64)required
Bodyapplication/json
labelsArray of integers(int64)
curl -i -X PUT \
  'https://api.observepoint.com/v3/alerts/{alertId}/labels' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "labels": [
      0
    ]
  }'

Responses

alert labels updated successfully

Response
No content

Get Alerts Library items

Request

POST /v3/alerts/library
Security
API_Key
Query
sizeinteger[ 50 .. 1000 ]
Default 50
pageinteger>= 0

Number of results page of an endpoint with paginated results

Default 0
sortDescboolean

Controls sorting order

Default false
sortBystring
Enum"ALERT_NAME""TARGET_ITEMS""REPORT_METRIC""UPDATED_AT""SUBSCRIBERS"
Bodyapplication/json
alertNamestringnon-empty

when present works as "alert name contains give substring` filter

metricTypestring

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"
labelsArray of integers(int64)non-empty
createdByUserIdinteger

ID of a user

Example: 123
isSubscribedboolean

When true then only those alerts will be returned that have Notification Profile of a requestor user assigned onto them

Default false
curl -i -X POST \
  'https://api.observepoint.com/v3/alerts/library?size=50&page=0&sortDesc=false&sortBy=ALERT_NAME' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "alertName": "string",
    "metricType": "ACCOUNT_USAGE_THIS_MONTH_AUDIT_PAGE_SCANNED_COUNT",
    "labels": [
      0
    ],
    "createdByUserId": 123,
    "isSubscribed": false
  }'

Responses

Alerts Library items

Bodyapplication/json
metadataobjectrequired

Common metadata for iterable

metadata.​paginationobjectrequired
metadata.​pagination.​totalCountintegerrequired

Total number of items available from all result pages combined

metadata.​pagination.​totalPageCountintegerrequired

Total number of pages available

metadata.​pagination.​pageSizeintegerrequired

Page size - number of items per result page configured by size query parameter or default page size

metadata.​pagination.​currentPageSizeintegerrequired

Number of items in current result page

metadata.​pagination.​currentPageNumberintegerrequired

Current page number/ordinal

alertsArray of objectsrequired
alerts[].​idinteger(int64)required
alerts[].​namestringnon-emptyrequired

User-defined name of the alert

alerts[].​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"
alerts[].​labelsArray of integers(int64)>= 0 itemsrequired
alerts[].​updatedAtstring(date-time)required

Date-time in RFC3339 profile ISO 8601 format with the following additional restrictions:

  1. An uppercase T must separate the date and time portions.
  2. An uppercase Z must denote that a numeric time zone offset isn't present.

In general, these timestamp requirements are the same in AWS Step Functions - Choice Rules

Example: "2016-08-18T17:33:00Z"
alerts[].​targetItemCountintegerrequired

Number of audits/journeys that have this alert configured

alerts[].​subscribedCountintegerrequired

Number of notification profiles configured for this alert

alerts[].​isOwnerbooleanrequired

Indicates whether the current user is the owner of this alert

Response
application/json
{
  "metadata": {
    "pagination": { … }
  },
  "alerts": [
    { … }
  ]
}

Get Alerts by metric

Request

GET /v3/alerts/metrics/{metricType}
Security
API_Key
Path
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"
Query
sizeinteger[ 50 .. 1000 ]
Default 50
pageinteger>= 0

Number of results page of an endpoint with paginated results

Default 0
sortDescboolean

Controls sorting order

Default false
sortBystring
Enum"ALERT_NAME""SUBSCRIBERS"
curl -i -X GET \
  'https://api.observepoint.com/v3/alerts/metrics/{metricType}?size=50&page=0&sortDesc=false&sortBy=ALERT_NAME' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

All alerts in an account with the same metric

Bodyapplication/json
metadataobjectrequired

Common metadata for iterable

metadata.​paginationobjectrequired
metadata.​pagination.​totalCountintegerrequired

Total number of items available from all result pages combined

metadata.​pagination.​totalPageCountintegerrequired

Total number of pages available

metadata.​pagination.​pageSizeintegerrequired

Page size - number of items per result page configured by size query parameter or default page size

metadata.​pagination.​currentPageSizeintegerrequired

Number of items in current result page

metadata.​pagination.​currentPageNumberintegerrequired

Current page number/ordinal

alertsArray of objectsrequired
alerts[].​namestringnon-emptyrequired

User-defined name of the alert

alerts[].​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"
alerts[].​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"
alerts[].​targetValueComparatorobjectrequired

Subtypes: - AlertMetricSpecificValueComparator - AlertMetricValueInRangeComparator - AlertMetricValueNotInRangeComparator

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

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

alerts[].​idinteger(int64)required
alerts[].​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"]
Response
application/json
{
  "metadata": {
    "pagination": { … }
  },
  "alerts": [
    { … }
  ]
}

Search target items (data sources - audits, journeys etc) that may have specified Alert assigned or not assigned

Request

POST /v3/alerts/target-items/{itemType}/search
Security
API_Key
Path
itemTypestringrequired
Enum"AUDIT""WEB_JOURNEY"
Query
sizeinteger[ 50 .. 1000 ]
Default 50
pageinteger>= 0

Number of results page of an endpoint with paginated results

Default 0
sortBystring
Enum"IS_ASSIGNED""ITEM_NAME""RUN_DATE"
sortDescboolean

Controls sorting order

Default false
Bodyapplication/json
alertIdinteger(int64)
assignedToAlertboolean

if alertId is NOT specified, assignedToAlert is ignored. if alertId IS specified assignedToAlert has 3 states: when TRUE - only items assigned to the specified alert will be returned; when FALSE - only NOT assigned; when NOT specified or NULL - both assigned and not assigned items will be returned

itemNamestringnon-empty

optional "item name contains substring" filter

itemIdinteger(int64)

ID of the item that can have assigned Alert(s) onto it. See also AlertAssignmentTypeEnum

itemLabelsArray of integers(int64)non-empty

non-empty array of labels present on an item, works as "item has all specified labels" filter

foldersArray of objectsnon-empty

non-empty array of folders with domains (subfolders), items from which will be included in response

curl -i -X POST \
  'https://api.observepoint.com/v3/alerts/target-items/{itemType}/search?size=50&page=0&sortBy=IS_ASSIGNED&sortDesc=false' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "alertId": 0,
    "assignedToAlert": true,
    "itemName": "string",
    "itemId": 0,
    "itemLabels": [
      0
    ],
    "folders": [
      {
        "folderId": 123,
        "domains": [
          123
        ]
      }
    ]
  }'

Responses

Items (data sources) that may have specified Alert assigned or not assigned

Bodyapplication/json
metadataobjectrequired

Common metadata for iterable

metadata.​paginationobjectrequired
metadata.​pagination.​totalCountintegerrequired

Total number of items available from all result pages combined

metadata.​pagination.​totalPageCountintegerrequired

Total number of pages available

metadata.​pagination.​pageSizeintegerrequired

Page size - number of items per result page configured by size query parameter or default page size

metadata.​pagination.​currentPageSizeintegerrequired

Number of items in current result page

metadata.​pagination.​currentPageNumberintegerrequired

Current page number/ordinal

itemsArray of objectsrequired
items[].​isAssignedbooleanrequired

TRUE if Alert is assigned to this item, FALSE otherwise

items[].​itemTypestringrequired
Enum"AUDIT""WEB_JOURNEY"
items[].​itemIdinteger(int64)required

ID of the item that can have assigned Alert(s) onto it. See also AlertAssignmentTypeEnum

items[].​itemNamestringrequired

Name of audit/WJ etc

items[].​itemLastRunAtstring(date-time)

Date-time in RFC3339 profile ISO 8601 format with the following additional restrictions:

  1. An uppercase T must separate the date and time portions.
  2. An uppercase Z must denote that a numeric time zone offset isn't present.

In general, these timestamp requirements are the same in AWS Step Functions - Choice Rules

Example: "2016-08-18T17:33:00Z"
items[].​itemLabelsArray of integers(int64)>= 0 items

may be absent if item does not support labels

Response
application/json
{
  "metadata": {
    "pagination": { … }
  },
  "items": [
    { … }
  ]
}

Update target items (data sources) that have specified Alert assigned

Request

PATCH /v3/alerts/{alertId}/target-items
Security
API_Key
Path
alertIdinteger(int64)required
Bodyapplication/json
assignmentUpdatesArray of objectsrequired
assignmentUpdates[].​scopestringrequired

For forward-compatibility

Value"SINGLE_ITEM"
assignmentUpdates[].​itemTypestringrequired
Enum"AUDIT""WEB_JOURNEY"
assignmentUpdates[].​itemIdinteger(int64)required

ID of the item that can have assigned Alert(s) onto it. See also AlertAssignmentTypeEnum

assignmentUpdates[].​operationstringrequired

Meaning by type:

  • ASSIGN: add (if not exist) or update (if already exists) alert assignment
  • UNASSIGN: remove alert assignment. Does nothing if assignment does not exist
Enum"ASSIGN""UNASSIGN"
curl -i -X PATCH \
  'https://api.observepoint.com/v3/alerts/{alertId}/target-items' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "assignmentUpdates": [
      {
        "scope": "SINGLE_ITEM",
        "itemType": "AUDIT",
        "itemId": 0,
        "operation": "ASSIGN"
      }
    ]
  }'

Responses

Updated successfully

Response
No content

Search Alerts for assigning them to other items (audits, WJs etc)

Request

POST /v3/alerts/search/assignments
Security
API_Key
Query
sizeinteger[ 50 .. 1000 ]
Default 50
pageinteger>= 0

Number of results page of an endpoint with paginated results

Default 0
sortBystring

Behaviour per type:

  • REPORT_METRIC: sort by name of data/report type corresponding to alert's metricType
Enum"ALERT_NAME""REPORT_METRIC"
sortDescboolean

Controls sorting order

Default false
Bodyapplication/json
targetItemobject

Item (audit/journey) alerts are assigned or not assigned to

searchstringnon-empty

When value is present it works as "alert name contains given substring" filter

labelsArray of integers(int64)non-empty

non-empty array of labels present on an alert, works as "alert has all specified labels" filter

isDefaultForNewDataSourcesboolean

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

curl -i -X POST \
  'https://api.observepoint.com/v3/alerts/search/assignments?size=50&page=0&sortBy=ALERT_NAME&sortDesc=false' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "targetItem": {
      "itemType": "AUDIT",
      "itemId": 0,
      "isAssigned": true
    },
    "search": "string",
    "labels": [
      0
    ],
    "isDefaultForNewDataSources": true
  }'

Responses

Assignments

Bodyapplication/json
metadataobjectrequired

Common metadata for iterable

metadata.​paginationobjectrequired
metadata.​pagination.​totalCountintegerrequired

Total number of items available from all result pages combined

metadata.​pagination.​totalPageCountintegerrequired

Total number of pages available

metadata.​pagination.​pageSizeintegerrequired

Page size - number of items per result page configured by size query parameter or default page size

metadata.​pagination.​currentPageSizeintegerrequired

Number of items in current result page

metadata.​pagination.​currentPageNumberintegerrequired

Current page number/ordinal

alertsArray of objects>= 0 itemsrequired
alerts[].​idinteger(int64)required
alerts[].​namestringnon-emptyrequired

User-defined name of the alert

alerts[].​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"
alerts[].​labelsArray of integers(int64)>= 0 itemsrequired
Response
application/json
{
  "metadata": {
    "pagination": { … }
  },
  "alerts": [
    { … }
  ]
}

Update Alerts assigned to specified item (audit, journey etc)

Request

PATCH /v3/alerts/assignments/{itemType}/{itemId}
Security
API_Key
Path
itemTypestringrequired
Enum"AUDIT""WEB_JOURNEY"
itemIdinteger(int64)required

ID of the item that can have assigned Alert(s) onto it. See also AlertAssignmentTypeEnum

Bodyapplication/json
assignmentUpdatesArray of objectsrequired
assignmentUpdates[].​alertIdinteger(int64)required
assignmentUpdates[].​operationstringrequired

Meaning by type:

  • ASSIGN: add (if not exist) or update (if already exists) alert assignment
  • UNASSIGN: remove alert assignment. Does nothing if assignment does not exist
Enum"ASSIGN""UNASSIGN"
curl -i -X PATCH \
  'https://api.observepoint.com/v3/alerts/assignments/{itemType}/{itemId}' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "assignmentUpdates": [
      {
        "alertId": 0,
        "operation": "ASSIGN"
      }
    ]
  }'

Responses

updated successfully

Response
No content

Account's Triggered Alerts

Account-level triggered alerts

Operations

Alert Export

Export alert data

Operations

Account Usage

Account usage data

Operations

Account Usage Alerts

Alerts related to account usage

Operations

Account Usage Export

Export account usage data

Operations

Notification Center

Find and manage email subscriptions

Operations

Email Inbox Messages

Get Email Inbox message details

Operations

Email Inbox Message Alerts

Email inbox message alerts

Operations