Skip to content
v3 API/
/
Get summary for all trigg...

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

Get summary for all triggered alerts for the account

Request

POST /v3/account-triggered-alerts/summary
Security
API_Key
Bodyapplication/json

Filters

runDateRangeobject

Should have from and/or to dates defined. from is inclusive and to is exclusive. to date should be after from date.

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"
alertNamestring

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

alertLabelsArray of integers(int64)non-empty

non-empty array of labels present on an alert

Example: [223]
itemNamestringnon-empty

optional "item name contains substring" filter

itemLabelsArray of integers(int64)non-empty

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

Example: [223]
itemTypestring
Enum"AUDIT""WEB_JOURNEY"
foldersArray of objectsnon-empty

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

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/account-triggered-alerts/summary \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "runDateRange": {
      "from": "2016-08-18T17:33:00Z",
      "to": "2016-08-18T17:33:00Z"
    },
    "metricTypes": [
      "ACCOUNT_USAGE_THIS_MONTH_AUDIT_PAGE_SCANNED_COUNT"
    ],
    "alertName": "string",
    "alertLabels": [
      223
    ],
    "itemName": "string",
    "itemLabels": [
      223
    ],
    "itemType": "AUDIT",
    "folders": [
      {
        "folderId": 123,
        "domains": [
          123
        ]
      }
    ],
    "subscribedOnly": true
  }'

Responses

Returns account triggered alerts summary

Bodyapplication/json
triggeredAlertAffectedPageCountintegerrequired
triggeredAlertsInMostRecentRunCountintegerrequired
auditsWithTriggeredAlertCountintegerrequired
triggeredUsageAlertCountintegerrequired
Response
application/json
{
  "triggeredAlertAffectedPageCount": 0,
  "triggeredAlertsInMostRecentRunCount": 0,
  "auditsWithTriggeredAlertCount": 0,
  "triggeredUsageAlertCount": 0
}

Get all triggered alerts for the account

Request

POST /v3/account-triggered-alerts/alerts
Security
API_Key
Query
pageinteger>= 0

Page number, starts with 0

Default 0
sizeinteger[ 50 .. 1000 ]
Default 50
sortBystring
Enum"RECENTLY_TRIGGERED_DATE""ALERT_NAME""REPORT_METRIC""PAGES_WITH_TRIGGERED_ALERTS""SUBSCRIBERS""DATA_SOURCES"
sortDescboolean

Controls sorting order

Default false
Bodyapplication/json

Filters

runDateRangeobject

Should have from and/or to dates defined. from is inclusive and to is exclusive. to date should be after from date.

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"
alertNamestring

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

alertLabelsArray of integers(int64)non-empty

non-empty array of labels present on an alert

Example: [223]
itemNamestringnon-empty

optional "item name contains substring" filter

itemLabelsArray of integers(int64)non-empty

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

Example: [223]
itemTypestring
Enum"AUDIT""WEB_JOURNEY"
foldersArray of objectsnon-empty

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

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/account-triggered-alerts/alerts?page=0&size=50&sortBy=RECENTLY_TRIGGERED_DATE&sortDesc=false' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "runDateRange": {
      "from": "2016-08-18T17:33:00Z",
      "to": "2016-08-18T17:33:00Z"
    },
    "metricTypes": [
      "ACCOUNT_USAGE_THIS_MONTH_AUDIT_PAGE_SCANNED_COUNT"
    ],
    "alertName": "string",
    "alertLabels": [
      223
    ],
    "itemName": "string",
    "itemLabels": [
      223
    ],
    "itemType": "AUDIT",
    "folders": [
      {
        "folderId": 123,
        "domains": [
          123
        ]
      }
    ],
    "subscribedOnly": true
  }'

Responses

Returns account triggered alerts list

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[].​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[].​appliedAlertPageCountintegerrequired
alerts[].​triggeredAlertAffectedPageCountintegerrequired
alerts[].​idinteger(int64)required
alerts[].​subscriberCountintegerrequired
alerts[].​isUserSubscribedbooleanrequired
alerts[].​recentTriggeredDatestring(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[].​dataSourceCountintegerrequired
alerts[].​alertConfigExistsbooleanrequired

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

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

Get information about specific alert from all triggered alerts for the account

Request

POST /v3/account-triggered-alerts/alerts/{alertId}
Security
API_Key
Path
alertIdinteger(int64)required
Query
pageinteger>= 0

Page number, starts with 0

Default 0
sizeinteger[ 50 .. 1000 ]
Default 50
sortBystring
Enum"RUN_DATE""DATA_SOURCE_NAME""PAGES_WITH_TRIGGERED_ALERTS"
sortDescboolean

Controls sorting order

Default false
Bodyapplication/json

Filters

runDateRangeobject

Should have from and/or to dates defined. from is inclusive and to is exclusive. to date should be after from date.

itemNamestringnon-empty

optional "item name contains substring" filter

itemLabelsArray of integers(int64)non-empty

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

Example: [223]
itemTypestring
Enum"AUDIT""WEB_JOURNEY"
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/account-triggered-alerts/alerts/{alertId}?page=0&size=50&sortBy=RUN_DATE&sortDesc=false' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "runDateRange": {
      "from": "2016-08-18T17:33:00Z",
      "to": "2016-08-18T17:33:00Z"
    },
    "itemName": "string",
    "itemLabels": [
      223
    ],
    "itemType": "AUDIT",
    "folders": [
      {
        "folderId": 123,
        "domains": [
          123
        ]
      }
    ]
  }'

Responses

Returns account triggered alerts specific alert details

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

dataSourcesArray of objects>= 0 itemsrequired
dataSources[].​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"
dataSources[].​actualValuenumber(double)

Value of the computed metric or its change.

dataSources[].​currentRunValuenumber(double)

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

dataSources[].​previousRunValuenumber(double)

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

dataSources[].​appliedAlertPageCountintegerrequired
dataSources[].​triggeredAlertAffectedPageCountintegerrequired
dataSources[].​runDatestring(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"
dataSources[].​itemNamestringrequired
dataSources[].​itemTypestringrequired
Enum"AUDIT""WEB_JOURNEY"
dataSources[].​runIdinteger(int64)required
Example: 33010
dataSources[].​itemIdinteger(int64)required

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

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

Account Usage Alerts

Alerts related to account usage

Operations

Alerts

Alert management and configuration

Operations

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