Skip to content
v3 API/
/
Update audit notes

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

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

Get audit notes by ID

Request

GET /v3/web-audits/{auditId}

Retrieve notes for a specific audit

Security
API_Key
Path
auditIdinteger(int64)required

Unique identification number for web audit

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

Responses

Audit notes

Bodyapplication/json
idinteger(int64)

Unique identifier for the audit notes

notesstring

Notes content for the audit

Response
application/json
{
  "id": 0,
  "notes": "string"
}

Update audit notes

Request

PUT /v3/web-audits/{auditId}

Update notes for a specific audit

Security
API_Key
Path
auditIdinteger(int64)required

Unique identification number for web audit

Example: 107239
Bodyapplication/jsonrequired

Updated audit notes

idinteger(int64)

Unique identifier for the audit notes

notesstring

Notes content for the audit

curl -i -X PUT \
  https://api.observepoint.com/v3/web-audits/107239 \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "id": 0,
    "notes": "string"
  }'

Responses

Updated audit notes

Bodyapplication/json
idinteger(int64)

Unique identifier for the audit notes

notesstring

Notes content for the audit

Response
application/json
{
  "id": 0,
  "notes": "string"
}

run audit now

Request

POST /v3/web-audits/{auditId}/runs
Security
API_Key
Path
auditIdinteger(int64)required

Unique identification number for web audit

Example: 107239
Bodyapplication/jsonrequired

Run the audit now. The request must contain the web-audit ID. Unlike v2 "run now" API, this API does not reject run requests if there is an active run.

startingUrlsArray of strings or null>= 0 items
callbackWorkflowEventTypestringrequired

The workflow file to be used in for starting the callback workflow Has to be a file name without extension, e.g. "audit-complete" instead of "audit-complete.yml"

callbackRepositoryOwnerstringrequired

The owner of the repository where the callback workflow is defined This is required to correctly invoke the callback workflow

callbackRepositoryNamestringrequired

The name of the repository where the callback workflow is defined This is required to correctly invoke the callback workflow

callbackContextobject

Contains a context for the callback URL to be used in the run

maxPagesinteger or null

Maximum number of pages to scan during the audit run. If not provided, will default to the count of starting URLs if it exceeds the current audit configuration limit.

ghAppNamestring

GitHub App to use for the callback workflow dispatch. Defaults to observepoint-integration if not specified (handled in service layer).

Enum"observepoint-integration""observepoint-test-app"
curl -i -X POST \
  https://api.observepoint.com/v3/web-audits/107239/runs \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "startingUrls": [
      "string"
    ],
    "callbackWorkflowEventType": "string",
    "callbackRepositoryOwner": "string",
    "callbackRepositoryName": "string",
    "callbackContext": {},
    "maxPages": 0,
    "ghAppName": "observepoint-integration"
  }'

Responses

Run started successfully

Response
No content

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