Skip to content
v3 API
/
Alert Summary Report
/
Get specific alert data (config + result) for specified audit run

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

Get Alerts statuses overview for specified audit run

Request

GET /v3/web-audits/{auditId}/runs/{runId}/reports/alert-summary/overview
Security
API_Key
Path
auditIdinteger(int64)required

Unique identification number for web audit

Example: 107239
runIdinteger(int64)required

Unique identification number for web audit or journey run

Example: 33010
curl -i -X GET \
  https://api.observepoint.com/v3/web-audits/107239/runs/33010/reports/alert-summary/overview \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Alert Summary alerts overview data

Bodyapplication/json
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[].​statusstringrequired

All statuses except TRIGGERED and NOT_TRIGGERED mean that alert/metric could not be computed. Statuses:

  • UNKNOWN_ERROR: data retrieval or alert computation failed
  • RUN_NOT_FOUND: requested run not found
  • NO_VALUE: no data found for requested run (e.g. rules or consent categories were not applied)
  • PREVIOUS_RUN_NOT_FOUND: previous run not found for run-over-run metric change alert
  • PREVIOUS_RUN_NO_VALUE: no data found for previous run for run-over-run metric change alert
Enum"TRIGGERED""NOT_TRIGGERED""UNKNOWN_ERROR""RUN_NOT_FOUND""NO_VALUE""PREVIOUS_RUN_NOT_FOUND""PREVIOUS_RUN_NO_VALUE"
alerts[].​isSubscribedbooleanrequired
alerts[].​alertConfigExistsbooleanrequired

when true then alert config exists and can be edited, otherwise it is deleted

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

Get Alert Summary alerts table data for specified audit run

Request

POST /v3/web-audits/{auditId}/runs/{runId}/reports/alert-summary/alerts
Security
API_Key
Path
auditIdinteger(int64)required

Unique identification number for web audit

Example: 107239
runIdinteger(int64)required

Unique identification number for web audit or journey run

Example: 33010
Query
pageinteger>= 0

Number of results page of an endpoint with paginated results

Default 0
sizeinteger[ 50 .. 1000 ]
Default 50
sortBystring
Enum"ALERT_NAME""ALERT_LOGIC""ACTUAL_VALUE""SUBSCRIBERS"
sortDescboolean

Controls sorting order

Default false
Bodyapplication/json

Filters applicable to Alert Summary report

alertNamestring

when populated works as "alert name contains given substring" filter

metricTypesArray of stringsnon-empty
Items 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"
statusstring

Simplified version of #/components/schemas/AlertResultStatusEnum for UI filters

Enum"TRIGGERED""NOT_TRIGGERED"
subscribedOnlyboolean

when false or null then all alerts are returned, otherwise only alerts user is subscribed to are returned

curl -i -X POST \
  'https://api.observepoint.com/v3/web-audits/107239/runs/33010/reports/alert-summary/alerts?page=0&size=50&sortBy=ALERT_NAME&sortDesc=false' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "alertName": "string",
    "metricTypes": [
      "ACCOUNT_USAGE_THIS_MONTH_AUDIT_PAGE_SCANNED_COUNT"
    ],
    "status": "TRIGGERED",
    "subscribedOnly": true
  }'

Responses

Alert Summary alerts data

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[].​configobjectrequired

Core parts of alert definition

alerts[].​config.​namestringnon-emptyrequired

User-defined name of the alert

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

Subtypes: - AlertMetricSpecificValueComparator - AlertMetricValueInRangeComparator - AlertMetricValueNotInRangeComparator

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

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

alerts[].​config.​subscriberCountintegerrequired
alerts[].​config.​isUserSubscribedbooleanrequired
alerts[].​resultobjectrequired
alerts[].​result.​statusstringrequired

All statuses except TRIGGERED and NOT_TRIGGERED mean that alert/metric could not be computed. Statuses:

  • UNKNOWN_ERROR: data retrieval or alert computation failed
  • RUN_NOT_FOUND: requested run not found
  • NO_VALUE: no data found for requested run (e.g. rules or consent categories were not applied)
  • PREVIOUS_RUN_NOT_FOUND: previous run not found for run-over-run metric change alert
  • PREVIOUS_RUN_NO_VALUE: no data found for previous run for run-over-run metric change alert
Enum"TRIGGERED""NOT_TRIGGERED""UNKNOWN_ERROR""RUN_NOT_FOUND""NO_VALUE""PREVIOUS_RUN_NOT_FOUND""PREVIOUS_RUN_NO_VALUE"
alerts[].​result.​actualValuenumber(double)

Value of the computed metric or its change.

alerts[].​result.​currentRunValuenumber(double)

Value of computed metric for current run. Present when alert is configured on metric change, not on single run metric value

alerts[].​result.​previousRunValuenumber(double)

Value of computed metric for previous run. Present when alert is configured on metric change, not on single run metric value

alerts[].​historyArray of objects[ 0 .. 20 ] itemsrequired

Returns up to 20 runs with alert results

alerts[].​history[].​runIdinteger(int64)required
Example: 33010
alerts[].​history[].​completedAtstring(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[].​history[].​statusstringrequired

All statuses except TRIGGERED and NOT_TRIGGERED mean that alert/metric could not be computed. Statuses:

  • UNKNOWN_ERROR: data retrieval or alert computation failed
  • RUN_NOT_FOUND: requested run not found
  • NO_VALUE: no data found for requested run (e.g. rules or consent categories were not applied)
  • PREVIOUS_RUN_NOT_FOUND: previous run not found for run-over-run metric change alert
  • PREVIOUS_RUN_NO_VALUE: no data found for previous run for run-over-run metric change alert
Enum"TRIGGERED""NOT_TRIGGERED""UNKNOWN_ERROR""RUN_NOT_FOUND""NO_VALUE""PREVIOUS_RUN_NOT_FOUND""PREVIOUS_RUN_NO_VALUE"
alerts[].​history[].​actualValuenumber(double)

Value of the computed metric or its change.

alerts[].​history[].​currentRunValuenumber(double)

Value of computed metric for current run. Present when alert is configured on metric change, not on single run metric value

alerts[].​history[].​previousRunValuenumber(double)

Value of computed metric for previous run. Present when alert is configured on metric change, not on single run metric value

alerts[].​alertConfigExistsbooleanrequired

when true then alert config exists and can be edited, otherwise it is deleted

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

Get specific alert data (config + result) for specified audit run

Request

GET /v3/web-audits/{auditId}/runs/{runId}/reports/alert-summary/alerts/{alertId}
Security
API_Key
Path
auditIdinteger(int64)required

Unique identification number for web audit

Example: 107239
runIdinteger(int64)required

Unique identification number for web audit or journey run

Example: 33010
alertIdinteger(int64)required
curl -i -X GET \
  'https://api.observepoint.com/v3/web-audits/107239/runs/33010/reports/alert-summary/alerts/{alertId}' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Alert Summary specific alert data

Bodyapplication/json
idinteger(int64)required
configobjectrequired

Core parts of alert definition

config.​namestringnon-emptyrequired

User-defined name of the alert

config.​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"
config.​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"
config.​targetValueComparatorobjectrequired

Subtypes: - AlertMetricSpecificValueComparator - AlertMetricValueInRangeComparator - AlertMetricValueNotInRangeComparator

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

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

config.​subscriberCountintegerrequired
config.​isUserSubscribedbooleanrequired
resultobjectrequired
result.​statusstringrequired

All statuses except TRIGGERED and NOT_TRIGGERED mean that alert/metric could not be computed. Statuses:

  • UNKNOWN_ERROR: data retrieval or alert computation failed
  • RUN_NOT_FOUND: requested run not found
  • NO_VALUE: no data found for requested run (e.g. rules or consent categories were not applied)
  • PREVIOUS_RUN_NOT_FOUND: previous run not found for run-over-run metric change alert
  • PREVIOUS_RUN_NO_VALUE: no data found for previous run for run-over-run metric change alert
Enum"TRIGGERED""NOT_TRIGGERED""UNKNOWN_ERROR""RUN_NOT_FOUND""NO_VALUE""PREVIOUS_RUN_NOT_FOUND""PREVIOUS_RUN_NO_VALUE"
result.​actualValuenumber(double)

Value of the computed metric or its change.

result.​currentRunValuenumber(double)

Value of computed metric for current run. Present when alert is configured on metric change, not on single run metric value

result.​previousRunValuenumber(double)

Value of computed metric for previous run. Present when alert is configured on metric change, not on single run metric value

alertConfigExistsbooleanrequired

when true then alert config exists and can be edited, otherwise it is deleted

Response
application/json
{
  "id": 0,
  "config": {
    "name": "string",
    "metricType": "ACCOUNT_USAGE_THIS_MONTH_AUDIT_PAGE_SCANNED_COUNT",
    "metricChangeType": "VALUE_CHANGE",
    "targetValueComparator": { … },
    "filtersV0": {},
    "subscriberCount": 0,
    "isUserSubscribed": true
  },
  "result": {
    "status": "TRIGGERED",
    "actualValue": 0.1,
    "currentRunValue": 0.1,
    "previousRunValue": 0.1
  },
  "alertConfigExists": true
}

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

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