Skip to content
v3 API/
/
Return insights on a give...

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

Return console logs generated on a given page

Request

POST /v3/web-audits/{auditId}/runs/{runId}/pages/{pageId}/console-log

Get browser console logs for specified audit run page

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
Query
pageinteger>= 0

Page number, starts with 0

Default 0
sizeinteger[ 50 .. 200 ]
Default 50
sortBystring
Enum"message""timestamp""level""source""count""related_tag"
sortDescboolean

Controls sorting order

Default false
Bodyapplication/json
includedLevelsArray of strings
Items Enum"error""warn""info""debug""other"
searchstring

Filters logs by message and source with 'contains' predicate

curl -i -X POST \
  'https://api.observepoint.com/v3/web-audits/107239/runs/33010/pages/f9d32cc7cc2046d6decb145a80289287f5226323/console-log?page=0&size=50&sortBy=message&sortDesc=false' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "includedLevels": [
      "error"
    ],
    "search": "string"
  }'

Responses

OK, return a list of console logs generated

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

consoleLogsArray of objectsrequired
consoleLogs[].​timestampinteger(int64)required
Example: 1612568767911
consoleLogs[].​messagestringrequired
Example: "loadscript added to queue: /path/to/example.js"
consoleLogs[].​levelstringrequired
Enum"error""warn""info""debug""other"
consoleLogs[].​sourcestring
consoleLogs[].​countintegerrequired
Example: 4
consoleLogs[].​relatedTagobject
Response
application/json
{
  "metadata": {
    "pagination": { … }
  },
  "consoleLogs": [
    { … }
  ]
}

Return insights on a given page for all runs in the given days

Request

GET /v3/web-audits/{auditId}/runs/{runId}/pages/{pageId}/sparklines
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/sparklines \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Page Insights by page Id

Bodyapplication/jsonArray [
runIdnumber
runCompletionDatestring(date-time)
pageInsightsobject
]
Response
application/json
[
  {
    "runId": 0,
    "runCompletionDate": "2019-08-24T14:15:22Z",
    "pageInsights": { … }
  }
]

Get Page Details Web Vitals trends relative to specified audit run

Request

GET /v3/web-audits/{auditId}/runs/{runId}/pages/{pageId}/trends/web-vitals
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/trends/web-vitals \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Page Details Web Vitals trends data

Bodyapplication/json
runsArray of objectsrequired
runs[].​runIdinteger(int64)required
Example: 33010
runs[].​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"
runs[].​largestContentfulPaintnumber(double)

LCP time in milliseconds

runs[].​firstContentfulPaintnumber(double)

FCP time in milliseconds

runs[].​timeToFirstBytenumber(double)

TTFB time in milliseconds

runs[].​cumulativeLayoutShiftnumber(double)

unitless measurement of CLS

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

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

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