Skip to content
v3 API/
/
Get Alert Summary 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

Page number, starts with 0

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 strings, non-empty
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

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

alertsArray of objectsrequired
Response
{
  "metadata": {
    "pagination": { … }
  },
  "alerts": [
    { … }
  ]
}