Skip to content
v3 API/
/
Get specific alert data (...

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
GET
/v3/web-audits/{auditId}/runs/{runId}/reports/alert-summary/alerts/{alertId}
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

resultobjectrequired
alertConfigExistsbooleanrequired

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

Response
{
  "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
}