Skip to content
v3 API/
/
Get run failures summary

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

Return a list of pages with JS variables

Request

GET /v3/web-audits/{auditId}/runs/{runId}/javascript-variables

Get all JS variables found on all the pages in a given audit run

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
sizeinteger[ 50 .. 1000 ]

Number of items to be returned at once

Default 50
startAfterPageIdstring

Offset result, start from pageId next to startAfterPageId. To fetch first page, don't supply this parameter. To fetch subsequent pages, supply metadata.pagination.lastPageId from previous response

Example: startAfterPageId=f9d32cc7cc2046d6decb145a80289287f5226323
curl -i -X GET \
  'https://api.observepoint.com/v3/web-audits/107239/runs/33010/javascript-variables?size=50&startAfterPageId=f9d32cc7cc2046d6decb145a80289287f5226323' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Pages with JS variables

Bodyapplication/json
metadataobjectrequired

Metadata for iterable results from S3

metadata.​paginationobjectrequired

Represents pagination metadata for results from S3, where each result page contains multiple pageIds. It's not possible to efficiently get total count of files in S3, so metadata is missing fields like totalCount and totalPageCount

metadata.​pagination.​pageSizeintegerrequired

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

Example: 50
metadata.​pagination.​currentPageSizeintegerrequired

Number of items in current result page

Example: 1
metadata.​pagination.​lastPageIdstring or nullrequired

Last pageId on current result page, pass it as startAfterPageId query param to retrieve next page. Null if no items were returned

Example: "f9d32cc7cc2046d6decb145a80289287f5226323"
pagesArray of objectsrequired
pages[].​pageIdstringrequired
Example: "f9d32cc7cc2046d6decb145a80289287f5226323"
pages[].​pageUrlstring(url)required
Example: "https://example.com/about"
pages[].​pageInitialStatusCodeintegerrequired

Page HTTP status code

pages[].​pageFinalStatusCodeintegerrequired

Page HTTP status code

pages[].​variablesArray of objectsrequired

All JS variables found on specific page

pages[].​variables[].​namestringrequired

Name of collected JS variable

Example: "dataLayer"
pages[].​variables[].​valueobject or nullrequired

Raw value of collected JS variable as it appeared on a page. Can be any value - string, number, boolean, array, object or null

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

Get run failures summary

Request

GET /v3/web-audits/{auditId}/runs/{runId}/reports/failures

Returns a summary of failures for the given run. Failures summary includes details for Pre-Audit Actions, On-Page Actions, all found links excluded and starting URLs navigation results.

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/failures \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

The result of the execution of the Audit Pre-Audit Actions if any

Bodyapplication/json
preAuditActionResultsobjectrequired
preAuditActionResults.​zeroAndOutbooleanrequired

Indicates whether pre-audit actions failed executing in all allocated engine containers.

preAuditActionResults.​preAuditActionFailuresArray of objectsnon-empty

Pre-audit action results failures. A a set of failed actions with their failure messages. Uniqueness is determined by the combination of failureMessage and auditActionSnapshotId.

onPagesActionResultsobject

(Optional) Present if failure/s is/are present for any Page's On-Page Actions execution

startingUrlResultsobject

Provide information for the following use cases: One and Out - All starting URLs failed to launch One and Out - All links found were excluded by filters

Response
application/json
{
  "preAuditActionResults": {
    "zeroAndOut": true,
    "preAuditActionFailures": [ … ]
  },
  "onPagesActionResults": {
    "totalConfiguredCount": 0,
    "totalFailedCount": 0,
    "resultsSample": [ … ]
  },
  "startingUrlResults": {
    "failureType": "no_links_scanned_one_and_out",
    "linksExcludedSample": [ … ],
    "startingUrlFailures": [ … ]
  }
}

Get audit run page screenshot URL

Request

GET /v3/web-audits/{auditId}/runs/{runId}/pages/{pageId}/screenshot

Returns an pre-signed S3 URL for audit run page card

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
pageIdstringrequired

Unique identification number for web audit run-page, it is different from dcUUID

Example: f9d32cc7cc2046d6decb145a80289287f5226323
curl -i -X GET \
  https://api.observepoint.com/v3/web-audits/107239/runs/33010/pages/f9d32cc7cc2046d6decb145a80289287f5226323/screenshot \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

redirect with pre-signed S3 URL for screenshot of a page of an audit run

Headers
Locationstring

The URL to which the client will be redirected

Response
No content

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

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